perfsonar 2.0 administration guide - terena · pdf fileperfsonar 2.0 administration guide...
TRANSCRIPT
perfSONAR 20 Administration Guide
Version 21
perfSONAR 20 Administration Guide
Document History ProductVersion Number perfSONAR 20 Date of Release 230707 Activity JRA1 Dissemination Level PP
Table of Contents
1 Introduction 1
11 How To Use This Guide 1
111 Document Conventions 1
12 Introducing perfSONAR 20 2
2 Installing perfSONAR 20 3
21 Points To Consider 4
22 perfSONAR 20 Prerequisites 4
221 Manual Installation of pre-requisites 4
222 Automatic Installation of pre-requisites 6
23 Using the perfSONAR 20 Bundle Installer 8
24 Interactive Questions 9
241 RRD Measurement Archive (Java) 9
242 SQL Measurement Archive 15
243 Lookup Service 21
244 SSHTelnet Measurement Point 25
245 Command Line Measurement Point 33
246 BWCTL Measurement Point 36
25 Advanced Installation 38
251 With the help of the bundle installer 38
252 With the help of ant or perl scripts which are part of each service 39
253 Re-configuration 40
3 Stitching 41
31 What is Stitching 41
32 RRD MA Stitching 41
33 SQL MA Stitching (utilisation and lightpath status) 41
34 SSH Telnet MP Stitching 42
4 Backing up your configurations 43
perfSONAR 21 i
perfSONAR 20 Administration Guide Introduction
5 Upgrading your existing RRD MA and SQL MA metadata configurations 44
6 Upgrading existing (lt20) perfSONAR software 46
7 Uninstallation 47
71 Uninstalling perfSONAR 10 bundle 47
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services 47
73 Uninstalling services bundled in 20 48
731 Uninstalling JAVA Services 48
732 Uninstalling Perl Services 49
74 Uninstalling perfSONAR 20 bundle 49
perfSONAR 21 ii
1 Introduction
This guide describes the installation and configuration processes for perfSONAR 20 It includes
bull A brief introduction to perfSONAR 20 bull Prerequisites needed before installing perfSONAR 20 bull Instructions for the installation and configuration process bull Instructions for implementing Stitching bull Uninstalling perfSONAR 20
11 How To Use This Guide
This guide is aimed at the perfSONAR System Administrator As such it assumes detailed knowledge of operating system software (Windows Linux and Unix) and of the software required for perfSONAR to be installed and operate (see ldquo22 perfSONAR 20 Prerequisitesrdquo on page 4)
Note It is crucial that you are familiar with the operating systems and software requirements before you attempt to install perfSONAR 20
111 Document Conventions
This documentation uses the following typographic conventions for menus commands keyboard keys and items in the program interface
Boldface Commands and names of interface items For example option buttons menu options and so on
Italics Placeholders for information or parameters that you provide For example filename in a procedure means you type the actual name of a file Italics are also used for new terms and the titles of books
hellip gt hellip Used to indicate selecting an option in a hierarchical menu structure For example
perfSONAR 21 1
perfSONAR 20 Administration Guide Introduction
Select Insert gt Picture gt From File
This instructs you to select the Insert option followed by the Picture option and finally the From File option
12 Introducing perfSONAR 20
perfSONAR (Performance focused Service Oriented Network monitoring Architecture) is now released as the perfSONAR 20 software bundle
The bundle has a number of enhancements to the original release
bull Each service is a separate productproject bull The bundle contains only the bundle installer which downloads tar balls of services that the user
wishes to install bull Multiple Services can be installed on same tomcat bull New installer script
Menu based interactive installation on-demand download of services Improved robustness with four steps for installation (pre-install configure deploy test) Java and perl services compatibility Installer written in perl (requires perl) but requires Apache Ant to install Java services
bull Includes four new services and two improved services New Services Command Line MP (Java) SSHTelnet MP (Java) BWCTL MP (Perl) SQL MA
(Java) Improved Services RRD MA (Java) Lookup Service (Java)
bull New features in all Services include Result codes used extensively converted most java exceptions returned to client into xml
result codes Echo functionality on all java services functions as a ping message to the service and helps in
determining status of deployments Automatic download and installation of Tomcat (all Java services) and eXist XML database
(RRD MA and SQL MA only) Lookup Service registrations and keep-alives across all six services
perfSONAR 20 also contains the building blocks for NRENs to provide a Multi-Domain Monitoring (MDM) service
This guide describes the installation process for perSONAR 20 The sections that follow describe
bull The prerequisites for perfSONAR 20 installation bull An overview of the perSONAR 20 installation process bull Detailed instructions of the individual steps of the process
perfSONAR 21 2
perfSONAR 20 Administration Guide Installing perfSONAR 20
2 Installing perfSONAR 20
To install perfSONAR 20 you must
1 Download the perfSONAR 20 bundle into an appropriate location on your system
bull Check the requirements section for the service that you wish to install See ldquo Only Java services can be installed in tomcat
2 perfSONAR 20 Prerequisitesrdquo on page 4
At a minimum check the manual installation requirements section and install any necessary pre-requisites See ldquo221 Manual Installation of pre-requisitesrdquo on page 4
3 Unzip and untar the bundle installer perfsonar-20targz
4 Unsetremove your existing CLASSPATH variable before starting
Make sure that the variable $CLASSPATH is empty You can do this by either removing from your bash_profile file or executing export CLASSPATH= in the command prompt before continuing with the next step
5 Execute the bundle installer using the command perl installpl
a Make sure you are in the perfsonar-bundle directory (for example homeperfsonarperfsonar-20-bundle)
b If perl is not on your PATH you will have to give the complete path to the perl binary - PERL_PATHperl installpl
See ldquo23 Using the perfSONAR 20 Bundle Installerrdquo on page 8
6 Follow the on-screen instructions Before you start installing a service be prepared for the questions that you will be asked
The on-screen dialogue will help you in the installation We recommend that you familiarise yourself with the questions and answers that the installer will ask you when you install a service See ldquo24Interactive Questionsrdquo on page 9
7 At the end of the installation the installer will perform tests on the installation You must verify the results to check your installation was successful
8 The Measurement Archives (RRD and SQL) require some ldquostitchingrdquo after installation See ldquo3 Stitchingrdquo on page 41
perfSONAR 21 3
perfSONAR 20 Administration Guide Installing perfSONAR 20
Note For RRD MA it is important that you set the LD_LIBRARY_PATH variable ideally in the profile where the service is installed This will make sure that whenever you restart tomcat or reboot the machine the variable is applied before tomcat is restarted If this is not done the service will not be able to read the configured RRD Files
21 Points To Consider
bull With perfSONAR 20 you can install any number of services on the same tomcat instance Apart from installations of different service types these installations could also include new instances of the same service type (you can install two SQL MA services on the same tomcat along with any other service type)
bull To make use of this feature be aware that If the service requires XML database (RRD MA SQL MA and LS) please make sure that you
configure each service to use a different username and password Do not use eXist XML Database USERNAMES AND COLLECTIONS across two installations
You must have a different document base for each service To do this choose a different service name than the one already in use (ex XML-LS-11 and XML-LS2-11 if they are on the same tomcat)
bull Only Java services can be installed in tomcat
22 perfSONAR 20 Prerequisites
The perfSONAR bundle contains six services (Web Services Applications) The prerequisites for installing each of these services are different Some of these requirements have to be manually installed while others can by automatically installed during the perfSONAR installation process However you can manually install all the requirements (including the automatic ones) if required
221 Manual Installation of pre-requisites
Depending on the applicationservice you wish to deploy you may be required to manually install some required software
The lists below define general prerequisites for all services followed by specific prerequisites for the individual service
Note Time durations given as rough estimates only and are given only as an indication of the effort involved They do not include stitching or installing operating systems
perfSONAR 21 4
perfSONAR 20 Administration Guide Installing perfSONAR 20
2211 General Requirements
Required for all services
bull Operating System Redhat LinuxFedora Other versions of unix are supported for most services but not all See the requirements for the
service that you want to install Installations on Windows not supported (some services RRD MA for example will not work) wget command should be available on the OS This is required by the installer to download
dependency software
bull Perl - version 561 or higher The Perl Module LWP
2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
bull JAVA (JDK 5 version 15) bull Apache Ant (Version 16x) bull RRDTool to read your RRD files (version 12x)
Make sure you have the following files related to RRDTool on your workstation mdash rrdh - Usually found in $RRDTOOL_HOMEinclude directory mdash Approximately 10 files starting with the name librrd They are usually found in
$RRDTOOL_HOMElib directory
Note During the installation and deployment process you will be required to setup LD_LIBRARY_PATH environment variable It is extremely important that this environment variable is set before every restart of Tomcat We suggest that the LD_LIBRARY_PATH environment variable declaration be added to the profile information of the account where this service is installed The installation process will suggest the value to be used for this variable
2213 SQL Measurement Archive - (Effort ~2 hr)
bull JAVA (JDK 5 - version 15) bull Apache Ant (version 16x) bull MySQL or PostgreSQL Relational Database
Mysql (version 50) PostgreSQL (version 8x)
perfSONAR 21 5
perfSONAR 20 Administration Guide Installing perfSONAR 20
2214 Lookup Service - (Effort ~15 hr)
bull JAVA (JDK 5 - version 15 or later) bull Apache Ant (16x) bull eXist XML Database (version 101 or 111)
Note You can re-use an already installed eXist XML database However if you are installing a new database we recommend installing it in tomcat as a webapp (download war file) Some configuration may be required after installation (see httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS for a short tutorial)
2215 SSHTelnet Measurement Point - (Effort ~20 hr)
bull JAVA (JDK 5 - version 15 or later - available here) bull Apache Ant - version 16x - available here bull You will also need to know the list of routersdevices and the commands on the routers that you
wish to make available via this tool
2216 Command Line Measurement Point - (Effort ~20 hr)
bull JAVA (JDK 5 - version 15 or later) bull Apache Ant (version 16x) bull OWAMP tool (version xx) bull BWCTL tool (version xx) bull Ping tool bull Traceroute tool
2217 BWCTL Measurement Point (Perl)
bull Operating System - Redhat LinuxFedora bull BWCTL MP not testedwont work on other flavors of unix OS bull Perl - version 561 or higher bull BWCTL tool (version 11b or later) bull Iperf tool (version 202 or later) bull Perl Modules that are required to be installed manually
None (unless automatic installations of the required modules fail)
222 Automatic Installation of pre-requisites
The following requirements can be installed automatically
perfSONAR 21 6
perfSONAR 20 Administration Guide Installing perfSONAR 20
Note Even if two services have common requirements it is not necessary to install the same software twice on the same workstation However you may want to record the directory where the software has been automatically installed
2221 RRD Measurement Archive (Java)
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later - available here) bull RRDJtool (as JNI)
2222 SQL Measurement Archive
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2223 Lookup Service
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2224 SSHTelnet Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2225 Command Line Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2226 BWCTL Measurement Point
bull Perl Modules that will be installed automatically Bit-Vector Carp-Clan Compress-Zlib Date-Calc Date-Manip HTML-Parser HTML-Tagset IO-Tty IPC-Run libwww-perl Log-Dispatch
perfSONAR 21 7
perfSONAR 20 Administration Guide Installing perfSONAR 20
Module-Build Params-Validate SOAP-Lite (version 066) URI XML-LibXML XML-LibXML-Common XML-NamespaceSupport XML-SAX XML-Writer XML-Writer-String
23 Using the perfSONAR 20 Bundle Installer
After you have downloaded and unzipped the perfSONAR 20 bundle you can start the installer by
9 Execute the bundle installer using the command perl installpl
a Make sure you are in the perfsonar-bundle directory (for example homeperfsonarperfsonar-20-bundle)
b If perl is not on your PATH you will have to give the complete path to the perl binary - PERL_PATHperl installpl
The installer starts
Note You can exit the installer at any time using the Exit command form the main menu or typing CTRL+C
10 The installer beginning screen displays three options
1 Install a new service Choose this option if you want to install a new service You can also use this option if you have already installed an instance of the same service (for example RRD MA) but would like to install another instance on the same machine
2 Modify or test an existing installation Choose this option to modify configuration details or test existing installations of perfSONAR services This option will not work if you have not already installed any of the services using the perfSONAR 20 bundle
3 Give feedback to the perfSONAR team Your feedback will be sent to us by the installer
If yoursquore installing a new service (and therefore select Option 1)
bull If you chose the first option the bundle installer provides a list of six services that can be installed Simply choose the service that you would like to install from this list
bull The bundle installer automatically downloads installation files for each service and executes the installation steps in sequence for the chosen service
bull Before downloading the installer files for a service the bundle installer will search to see if it can find existing downloads of installation files If you want to install two instances of the same service on the same workstation you can re-use the already downloaded installation files This will not affect the first instance
perfSONAR 21 8
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull If the bundle installer cannot find installation files it will give you the option to either ask it to download the files and install or you can specify an alternate path where the files have been downloaded previously
bull If files have to be downloaded the installer will automatically download and extract the required files It will ask you if you want it to extract to location different from the default one We suggest that you choose the default location
bull After downloading the required files (or accepting an existing installation files directory) the bundle installer will ask you if you want to do a basic installation or an advanced one Choose the basic installation unless you are feeling adventurous See ldquo25 Advanced Installationrdquo on page 38 The steps below are for basic installation
bull Depending on the service chosen you will be asked several questions If you make a mistake at any time quit (CTRL+C) and you can start again (bundle installer will ask you) If you experience some problems or have some questions try out the support pages (FAQs) or contact the mailing list
24 Interactive Questions
The perfSONAR installer prompts you for the information required to install the bundled software
Below are the prompts and questions you need to answer subdivided by service
Note Please review these questions and have all the required information ready to hand before installing the software Explanations for each question are given below and appropriate defaults are included whenever possible
241 RRD Measurement Archive (Java)
2411 Pre-installation
Enter the name of the service [perfSONAR-RRD-MA-20]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-RRD-MA-20
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
perfSONAR 21 9
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [1]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation This is the port number that will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you need another port number then you must also setup Tomcat to use this
new number To do this open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Do you want me to compile rrdjtool library for you (if not you will have to do it manually in
rootperfSONAR-RRD-MA-20perfsonarcontribrrdjtool after pre-install step) (yn)
bull Explanation The service needs the library of rrdjtool which is an interface to RRD files The script can build the library for you if the answer is y
bull Default none
IF answer is y Enter operating system type (linuxlinux-64bitfreebsdsolarisother)
perfSONAR 21 10
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information what OS do you have on your machine You can find a list of accepted operating systems in round brackets
bull Default none
IF answer is y Enter the directory path where header file of the rrdtool (rrdh) can be found [usrlocalrrdtoolinclude]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where the header file of rrdtool is located
bull Default usrlocalrrdtoolinclude bull Recommendation The path in square brackets in only an example
IF answer is y Enter the directory path where library files of the rrdtool (librrd) can be found [usrlocalrrdtoollib]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where library files of rrdtool are located
bull Default usrlocalrrdtoollib bull Recommendation The path in square brackets in only an example
IF answer is y Enter the home directory where the Java is installed (I need the home directory and not the directory where
the executable binary is present) [usrlocaljdk150]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where Java installation is located (rrdjtool is a java library so Java is required for building)
bull Default usrlocaljdk150 bull Recommendation The path in square brackets in only an example
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
perfSONAR 21 11
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter a URL of eXist web application package (exist-101war) [2]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example rrdmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank)
perfSONAR 21 12
perfSONAR 20 Administration Guide Installing perfSONAR 20
everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2412 Configuration
Enter the path of rrd metadata configuration file [rootperfSONAR-RRD-MA-20perfsonarconfrrd-database_TESTxml]
bull Explanation The script asks for the metadata configuration file This file contains the description of measurement data in RRD files If you wanted to use the xml database in the pre-install step then the metadata configuration file will be stored there later on during the Deployment
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in RRD files
bull Default none
Enter location of new RRD files created when measurement data is sent to the service [rootwebapps]
bull Explanation The service can receive messages with measurement data and store them in RRD files Here the script asks for the location where the service will create new RRD files
bull Default ltcurrent_directorygtwebapps
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
2413 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
perfSONAR 21 13
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-RRD-MA-20
[echo] docBase=rootwebappsperfSONAR-RRD-MA-20gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that Tomcat is running
[echo] You can do it using your web browser and connect the address http1270018080
[echo] or looking at Tomcats log file (rootapache-tomcat-607logscatalinaout)
Press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
Do you want me to add new user (provided in the pre-install step) and initiate the xml database eXist (If your eXist
is already configured and initialized for RRD MA answer n But probably its your first run of this installation script
so you have not added this user and initialized the database yet) (yn)
bull Explanation In case of use of the xml database eXist it needs to be set up (this means it must have an account and the metadata configuration specified in the pre-install and configure steps of the installation procedure)
bull Default none bull Recommendation If the xml database already has been set up the answer should be n
perfSONAR 21 14
perfSONAR 20 Administration Guide Installing perfSONAR 20
242 SQL Measurement Archive
2421 Pre-install step
Enter the name of the service [perfSONAR-SQL-MA-10]
bull Explanation - The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-SQL-MA-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [3]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
perfSONAR 21 15
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
IF answer is y Enter a URL of eXist web application package (exist-101war) [4]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
perfSONAR 21 16
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example sqlmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank) everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2422 Configuration
[echo] This service requires access to the relational database
[echo] (mySQL or postgeSQL but others can be used as well)
[echo] Make sure that you have one or install it from scratch
Please do it now and press Enter when finished
bull Explanation The script wants to know if a relational database is installed on the system If you already have one installed just press Enter If not please install one at this point and then press Enter so that the script can continue the installation of the service
bull Default none
[echo] In order to maintain data of utilization metric andor L2 path status metric
[echo] please prepare your relational database
[echo] In case of mySQL use simple script file mysql-sqlma-dbsetupsql
[echo] that you can find in conf directory (rootperfSONAR-SQL-MA-10perfsonarconf)
[echo] of perfSONAR SQL MA installation package
perfSONAR 21 17
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide
Document History ProductVersion Number perfSONAR 20 Date of Release 230707 Activity JRA1 Dissemination Level PP
Table of Contents
1 Introduction 1
11 How To Use This Guide 1
111 Document Conventions 1
12 Introducing perfSONAR 20 2
2 Installing perfSONAR 20 3
21 Points To Consider 4
22 perfSONAR 20 Prerequisites 4
221 Manual Installation of pre-requisites 4
222 Automatic Installation of pre-requisites 6
23 Using the perfSONAR 20 Bundle Installer 8
24 Interactive Questions 9
241 RRD Measurement Archive (Java) 9
242 SQL Measurement Archive 15
243 Lookup Service 21
244 SSHTelnet Measurement Point 25
245 Command Line Measurement Point 33
246 BWCTL Measurement Point 36
25 Advanced Installation 38
251 With the help of the bundle installer 38
252 With the help of ant or perl scripts which are part of each service 39
253 Re-configuration 40
3 Stitching 41
31 What is Stitching 41
32 RRD MA Stitching 41
33 SQL MA Stitching (utilisation and lightpath status) 41
34 SSH Telnet MP Stitching 42
4 Backing up your configurations 43
perfSONAR 21 i
perfSONAR 20 Administration Guide Introduction
5 Upgrading your existing RRD MA and SQL MA metadata configurations 44
6 Upgrading existing (lt20) perfSONAR software 46
7 Uninstallation 47
71 Uninstalling perfSONAR 10 bundle 47
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services 47
73 Uninstalling services bundled in 20 48
731 Uninstalling JAVA Services 48
732 Uninstalling Perl Services 49
74 Uninstalling perfSONAR 20 bundle 49
perfSONAR 21 ii
1 Introduction
This guide describes the installation and configuration processes for perfSONAR 20 It includes
bull A brief introduction to perfSONAR 20 bull Prerequisites needed before installing perfSONAR 20 bull Instructions for the installation and configuration process bull Instructions for implementing Stitching bull Uninstalling perfSONAR 20
11 How To Use This Guide
This guide is aimed at the perfSONAR System Administrator As such it assumes detailed knowledge of operating system software (Windows Linux and Unix) and of the software required for perfSONAR to be installed and operate (see ldquo22 perfSONAR 20 Prerequisitesrdquo on page 4)
Note It is crucial that you are familiar with the operating systems and software requirements before you attempt to install perfSONAR 20
111 Document Conventions
This documentation uses the following typographic conventions for menus commands keyboard keys and items in the program interface
Boldface Commands and names of interface items For example option buttons menu options and so on
Italics Placeholders for information or parameters that you provide For example filename in a procedure means you type the actual name of a file Italics are also used for new terms and the titles of books
hellip gt hellip Used to indicate selecting an option in a hierarchical menu structure For example
perfSONAR 21 1
perfSONAR 20 Administration Guide Introduction
Select Insert gt Picture gt From File
This instructs you to select the Insert option followed by the Picture option and finally the From File option
12 Introducing perfSONAR 20
perfSONAR (Performance focused Service Oriented Network monitoring Architecture) is now released as the perfSONAR 20 software bundle
The bundle has a number of enhancements to the original release
bull Each service is a separate productproject bull The bundle contains only the bundle installer which downloads tar balls of services that the user
wishes to install bull Multiple Services can be installed on same tomcat bull New installer script
Menu based interactive installation on-demand download of services Improved robustness with four steps for installation (pre-install configure deploy test) Java and perl services compatibility Installer written in perl (requires perl) but requires Apache Ant to install Java services
bull Includes four new services and two improved services New Services Command Line MP (Java) SSHTelnet MP (Java) BWCTL MP (Perl) SQL MA
(Java) Improved Services RRD MA (Java) Lookup Service (Java)
bull New features in all Services include Result codes used extensively converted most java exceptions returned to client into xml
result codes Echo functionality on all java services functions as a ping message to the service and helps in
determining status of deployments Automatic download and installation of Tomcat (all Java services) and eXist XML database
(RRD MA and SQL MA only) Lookup Service registrations and keep-alives across all six services
perfSONAR 20 also contains the building blocks for NRENs to provide a Multi-Domain Monitoring (MDM) service
This guide describes the installation process for perSONAR 20 The sections that follow describe
bull The prerequisites for perfSONAR 20 installation bull An overview of the perSONAR 20 installation process bull Detailed instructions of the individual steps of the process
perfSONAR 21 2
perfSONAR 20 Administration Guide Installing perfSONAR 20
2 Installing perfSONAR 20
To install perfSONAR 20 you must
1 Download the perfSONAR 20 bundle into an appropriate location on your system
bull Check the requirements section for the service that you wish to install See ldquo Only Java services can be installed in tomcat
2 perfSONAR 20 Prerequisitesrdquo on page 4
At a minimum check the manual installation requirements section and install any necessary pre-requisites See ldquo221 Manual Installation of pre-requisitesrdquo on page 4
3 Unzip and untar the bundle installer perfsonar-20targz
4 Unsetremove your existing CLASSPATH variable before starting
Make sure that the variable $CLASSPATH is empty You can do this by either removing from your bash_profile file or executing export CLASSPATH= in the command prompt before continuing with the next step
5 Execute the bundle installer using the command perl installpl
a Make sure you are in the perfsonar-bundle directory (for example homeperfsonarperfsonar-20-bundle)
b If perl is not on your PATH you will have to give the complete path to the perl binary - PERL_PATHperl installpl
See ldquo23 Using the perfSONAR 20 Bundle Installerrdquo on page 8
6 Follow the on-screen instructions Before you start installing a service be prepared for the questions that you will be asked
The on-screen dialogue will help you in the installation We recommend that you familiarise yourself with the questions and answers that the installer will ask you when you install a service See ldquo24Interactive Questionsrdquo on page 9
7 At the end of the installation the installer will perform tests on the installation You must verify the results to check your installation was successful
8 The Measurement Archives (RRD and SQL) require some ldquostitchingrdquo after installation See ldquo3 Stitchingrdquo on page 41
perfSONAR 21 3
perfSONAR 20 Administration Guide Installing perfSONAR 20
Note For RRD MA it is important that you set the LD_LIBRARY_PATH variable ideally in the profile where the service is installed This will make sure that whenever you restart tomcat or reboot the machine the variable is applied before tomcat is restarted If this is not done the service will not be able to read the configured RRD Files
21 Points To Consider
bull With perfSONAR 20 you can install any number of services on the same tomcat instance Apart from installations of different service types these installations could also include new instances of the same service type (you can install two SQL MA services on the same tomcat along with any other service type)
bull To make use of this feature be aware that If the service requires XML database (RRD MA SQL MA and LS) please make sure that you
configure each service to use a different username and password Do not use eXist XML Database USERNAMES AND COLLECTIONS across two installations
You must have a different document base for each service To do this choose a different service name than the one already in use (ex XML-LS-11 and XML-LS2-11 if they are on the same tomcat)
bull Only Java services can be installed in tomcat
22 perfSONAR 20 Prerequisites
The perfSONAR bundle contains six services (Web Services Applications) The prerequisites for installing each of these services are different Some of these requirements have to be manually installed while others can by automatically installed during the perfSONAR installation process However you can manually install all the requirements (including the automatic ones) if required
221 Manual Installation of pre-requisites
Depending on the applicationservice you wish to deploy you may be required to manually install some required software
The lists below define general prerequisites for all services followed by specific prerequisites for the individual service
Note Time durations given as rough estimates only and are given only as an indication of the effort involved They do not include stitching or installing operating systems
perfSONAR 21 4
perfSONAR 20 Administration Guide Installing perfSONAR 20
2211 General Requirements
Required for all services
bull Operating System Redhat LinuxFedora Other versions of unix are supported for most services but not all See the requirements for the
service that you want to install Installations on Windows not supported (some services RRD MA for example will not work) wget command should be available on the OS This is required by the installer to download
dependency software
bull Perl - version 561 or higher The Perl Module LWP
2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
bull JAVA (JDK 5 version 15) bull Apache Ant (Version 16x) bull RRDTool to read your RRD files (version 12x)
Make sure you have the following files related to RRDTool on your workstation mdash rrdh - Usually found in $RRDTOOL_HOMEinclude directory mdash Approximately 10 files starting with the name librrd They are usually found in
$RRDTOOL_HOMElib directory
Note During the installation and deployment process you will be required to setup LD_LIBRARY_PATH environment variable It is extremely important that this environment variable is set before every restart of Tomcat We suggest that the LD_LIBRARY_PATH environment variable declaration be added to the profile information of the account where this service is installed The installation process will suggest the value to be used for this variable
2213 SQL Measurement Archive - (Effort ~2 hr)
bull JAVA (JDK 5 - version 15) bull Apache Ant (version 16x) bull MySQL or PostgreSQL Relational Database
Mysql (version 50) PostgreSQL (version 8x)
perfSONAR 21 5
perfSONAR 20 Administration Guide Installing perfSONAR 20
2214 Lookup Service - (Effort ~15 hr)
bull JAVA (JDK 5 - version 15 or later) bull Apache Ant (16x) bull eXist XML Database (version 101 or 111)
Note You can re-use an already installed eXist XML database However if you are installing a new database we recommend installing it in tomcat as a webapp (download war file) Some configuration may be required after installation (see httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS for a short tutorial)
2215 SSHTelnet Measurement Point - (Effort ~20 hr)
bull JAVA (JDK 5 - version 15 or later - available here) bull Apache Ant - version 16x - available here bull You will also need to know the list of routersdevices and the commands on the routers that you
wish to make available via this tool
2216 Command Line Measurement Point - (Effort ~20 hr)
bull JAVA (JDK 5 - version 15 or later) bull Apache Ant (version 16x) bull OWAMP tool (version xx) bull BWCTL tool (version xx) bull Ping tool bull Traceroute tool
2217 BWCTL Measurement Point (Perl)
bull Operating System - Redhat LinuxFedora bull BWCTL MP not testedwont work on other flavors of unix OS bull Perl - version 561 or higher bull BWCTL tool (version 11b or later) bull Iperf tool (version 202 or later) bull Perl Modules that are required to be installed manually
None (unless automatic installations of the required modules fail)
222 Automatic Installation of pre-requisites
The following requirements can be installed automatically
perfSONAR 21 6
perfSONAR 20 Administration Guide Installing perfSONAR 20
Note Even if two services have common requirements it is not necessary to install the same software twice on the same workstation However you may want to record the directory where the software has been automatically installed
2221 RRD Measurement Archive (Java)
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later - available here) bull RRDJtool (as JNI)
2222 SQL Measurement Archive
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2223 Lookup Service
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2224 SSHTelnet Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2225 Command Line Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2226 BWCTL Measurement Point
bull Perl Modules that will be installed automatically Bit-Vector Carp-Clan Compress-Zlib Date-Calc Date-Manip HTML-Parser HTML-Tagset IO-Tty IPC-Run libwww-perl Log-Dispatch
perfSONAR 21 7
perfSONAR 20 Administration Guide Installing perfSONAR 20
Module-Build Params-Validate SOAP-Lite (version 066) URI XML-LibXML XML-LibXML-Common XML-NamespaceSupport XML-SAX XML-Writer XML-Writer-String
23 Using the perfSONAR 20 Bundle Installer
After you have downloaded and unzipped the perfSONAR 20 bundle you can start the installer by
9 Execute the bundle installer using the command perl installpl
a Make sure you are in the perfsonar-bundle directory (for example homeperfsonarperfsonar-20-bundle)
b If perl is not on your PATH you will have to give the complete path to the perl binary - PERL_PATHperl installpl
The installer starts
Note You can exit the installer at any time using the Exit command form the main menu or typing CTRL+C
10 The installer beginning screen displays three options
1 Install a new service Choose this option if you want to install a new service You can also use this option if you have already installed an instance of the same service (for example RRD MA) but would like to install another instance on the same machine
2 Modify or test an existing installation Choose this option to modify configuration details or test existing installations of perfSONAR services This option will not work if you have not already installed any of the services using the perfSONAR 20 bundle
3 Give feedback to the perfSONAR team Your feedback will be sent to us by the installer
If yoursquore installing a new service (and therefore select Option 1)
bull If you chose the first option the bundle installer provides a list of six services that can be installed Simply choose the service that you would like to install from this list
bull The bundle installer automatically downloads installation files for each service and executes the installation steps in sequence for the chosen service
bull Before downloading the installer files for a service the bundle installer will search to see if it can find existing downloads of installation files If you want to install two instances of the same service on the same workstation you can re-use the already downloaded installation files This will not affect the first instance
perfSONAR 21 8
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull If the bundle installer cannot find installation files it will give you the option to either ask it to download the files and install or you can specify an alternate path where the files have been downloaded previously
bull If files have to be downloaded the installer will automatically download and extract the required files It will ask you if you want it to extract to location different from the default one We suggest that you choose the default location
bull After downloading the required files (or accepting an existing installation files directory) the bundle installer will ask you if you want to do a basic installation or an advanced one Choose the basic installation unless you are feeling adventurous See ldquo25 Advanced Installationrdquo on page 38 The steps below are for basic installation
bull Depending on the service chosen you will be asked several questions If you make a mistake at any time quit (CTRL+C) and you can start again (bundle installer will ask you) If you experience some problems or have some questions try out the support pages (FAQs) or contact the mailing list
24 Interactive Questions
The perfSONAR installer prompts you for the information required to install the bundled software
Below are the prompts and questions you need to answer subdivided by service
Note Please review these questions and have all the required information ready to hand before installing the software Explanations for each question are given below and appropriate defaults are included whenever possible
241 RRD Measurement Archive (Java)
2411 Pre-installation
Enter the name of the service [perfSONAR-RRD-MA-20]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-RRD-MA-20
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
perfSONAR 21 9
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [1]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation This is the port number that will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you need another port number then you must also setup Tomcat to use this
new number To do this open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Do you want me to compile rrdjtool library for you (if not you will have to do it manually in
rootperfSONAR-RRD-MA-20perfsonarcontribrrdjtool after pre-install step) (yn)
bull Explanation The service needs the library of rrdjtool which is an interface to RRD files The script can build the library for you if the answer is y
bull Default none
IF answer is y Enter operating system type (linuxlinux-64bitfreebsdsolarisother)
perfSONAR 21 10
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information what OS do you have on your machine You can find a list of accepted operating systems in round brackets
bull Default none
IF answer is y Enter the directory path where header file of the rrdtool (rrdh) can be found [usrlocalrrdtoolinclude]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where the header file of rrdtool is located
bull Default usrlocalrrdtoolinclude bull Recommendation The path in square brackets in only an example
IF answer is y Enter the directory path where library files of the rrdtool (librrd) can be found [usrlocalrrdtoollib]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where library files of rrdtool are located
bull Default usrlocalrrdtoollib bull Recommendation The path in square brackets in only an example
IF answer is y Enter the home directory where the Java is installed (I need the home directory and not the directory where
the executable binary is present) [usrlocaljdk150]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where Java installation is located (rrdjtool is a java library so Java is required for building)
bull Default usrlocaljdk150 bull Recommendation The path in square brackets in only an example
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
perfSONAR 21 11
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter a URL of eXist web application package (exist-101war) [2]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example rrdmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank)
perfSONAR 21 12
perfSONAR 20 Administration Guide Installing perfSONAR 20
everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2412 Configuration
Enter the path of rrd metadata configuration file [rootperfSONAR-RRD-MA-20perfsonarconfrrd-database_TESTxml]
bull Explanation The script asks for the metadata configuration file This file contains the description of measurement data in RRD files If you wanted to use the xml database in the pre-install step then the metadata configuration file will be stored there later on during the Deployment
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in RRD files
bull Default none
Enter location of new RRD files created when measurement data is sent to the service [rootwebapps]
bull Explanation The service can receive messages with measurement data and store them in RRD files Here the script asks for the location where the service will create new RRD files
bull Default ltcurrent_directorygtwebapps
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
2413 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
perfSONAR 21 13
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-RRD-MA-20
[echo] docBase=rootwebappsperfSONAR-RRD-MA-20gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that Tomcat is running
[echo] You can do it using your web browser and connect the address http1270018080
[echo] or looking at Tomcats log file (rootapache-tomcat-607logscatalinaout)
Press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
Do you want me to add new user (provided in the pre-install step) and initiate the xml database eXist (If your eXist
is already configured and initialized for RRD MA answer n But probably its your first run of this installation script
so you have not added this user and initialized the database yet) (yn)
bull Explanation In case of use of the xml database eXist it needs to be set up (this means it must have an account and the metadata configuration specified in the pre-install and configure steps of the installation procedure)
bull Default none bull Recommendation If the xml database already has been set up the answer should be n
perfSONAR 21 14
perfSONAR 20 Administration Guide Installing perfSONAR 20
242 SQL Measurement Archive
2421 Pre-install step
Enter the name of the service [perfSONAR-SQL-MA-10]
bull Explanation - The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-SQL-MA-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [3]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
perfSONAR 21 15
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
IF answer is y Enter a URL of eXist web application package (exist-101war) [4]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
perfSONAR 21 16
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example sqlmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank) everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2422 Configuration
[echo] This service requires access to the relational database
[echo] (mySQL or postgeSQL but others can be used as well)
[echo] Make sure that you have one or install it from scratch
Please do it now and press Enter when finished
bull Explanation The script wants to know if a relational database is installed on the system If you already have one installed just press Enter If not please install one at this point and then press Enter so that the script can continue the installation of the service
bull Default none
[echo] In order to maintain data of utilization metric andor L2 path status metric
[echo] please prepare your relational database
[echo] In case of mySQL use simple script file mysql-sqlma-dbsetupsql
[echo] that you can find in conf directory (rootperfSONAR-SQL-MA-10perfsonarconf)
[echo] of perfSONAR SQL MA installation package
perfSONAR 21 17
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
Table of Contents
1 Introduction 1
11 How To Use This Guide 1
111 Document Conventions 1
12 Introducing perfSONAR 20 2
2 Installing perfSONAR 20 3
21 Points To Consider 4
22 perfSONAR 20 Prerequisites 4
221 Manual Installation of pre-requisites 4
222 Automatic Installation of pre-requisites 6
23 Using the perfSONAR 20 Bundle Installer 8
24 Interactive Questions 9
241 RRD Measurement Archive (Java) 9
242 SQL Measurement Archive 15
243 Lookup Service 21
244 SSHTelnet Measurement Point 25
245 Command Line Measurement Point 33
246 BWCTL Measurement Point 36
25 Advanced Installation 38
251 With the help of the bundle installer 38
252 With the help of ant or perl scripts which are part of each service 39
253 Re-configuration 40
3 Stitching 41
31 What is Stitching 41
32 RRD MA Stitching 41
33 SQL MA Stitching (utilisation and lightpath status) 41
34 SSH Telnet MP Stitching 42
4 Backing up your configurations 43
perfSONAR 21 i
perfSONAR 20 Administration Guide Introduction
5 Upgrading your existing RRD MA and SQL MA metadata configurations 44
6 Upgrading existing (lt20) perfSONAR software 46
7 Uninstallation 47
71 Uninstalling perfSONAR 10 bundle 47
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services 47
73 Uninstalling services bundled in 20 48
731 Uninstalling JAVA Services 48
732 Uninstalling Perl Services 49
74 Uninstalling perfSONAR 20 bundle 49
perfSONAR 21 ii
1 Introduction
This guide describes the installation and configuration processes for perfSONAR 20 It includes
bull A brief introduction to perfSONAR 20 bull Prerequisites needed before installing perfSONAR 20 bull Instructions for the installation and configuration process bull Instructions for implementing Stitching bull Uninstalling perfSONAR 20
11 How To Use This Guide
This guide is aimed at the perfSONAR System Administrator As such it assumes detailed knowledge of operating system software (Windows Linux and Unix) and of the software required for perfSONAR to be installed and operate (see ldquo22 perfSONAR 20 Prerequisitesrdquo on page 4)
Note It is crucial that you are familiar with the operating systems and software requirements before you attempt to install perfSONAR 20
111 Document Conventions
This documentation uses the following typographic conventions for menus commands keyboard keys and items in the program interface
Boldface Commands and names of interface items For example option buttons menu options and so on
Italics Placeholders for information or parameters that you provide For example filename in a procedure means you type the actual name of a file Italics are also used for new terms and the titles of books
hellip gt hellip Used to indicate selecting an option in a hierarchical menu structure For example
perfSONAR 21 1
perfSONAR 20 Administration Guide Introduction
Select Insert gt Picture gt From File
This instructs you to select the Insert option followed by the Picture option and finally the From File option
12 Introducing perfSONAR 20
perfSONAR (Performance focused Service Oriented Network monitoring Architecture) is now released as the perfSONAR 20 software bundle
The bundle has a number of enhancements to the original release
bull Each service is a separate productproject bull The bundle contains only the bundle installer which downloads tar balls of services that the user
wishes to install bull Multiple Services can be installed on same tomcat bull New installer script
Menu based interactive installation on-demand download of services Improved robustness with four steps for installation (pre-install configure deploy test) Java and perl services compatibility Installer written in perl (requires perl) but requires Apache Ant to install Java services
bull Includes four new services and two improved services New Services Command Line MP (Java) SSHTelnet MP (Java) BWCTL MP (Perl) SQL MA
(Java) Improved Services RRD MA (Java) Lookup Service (Java)
bull New features in all Services include Result codes used extensively converted most java exceptions returned to client into xml
result codes Echo functionality on all java services functions as a ping message to the service and helps in
determining status of deployments Automatic download and installation of Tomcat (all Java services) and eXist XML database
(RRD MA and SQL MA only) Lookup Service registrations and keep-alives across all six services
perfSONAR 20 also contains the building blocks for NRENs to provide a Multi-Domain Monitoring (MDM) service
This guide describes the installation process for perSONAR 20 The sections that follow describe
bull The prerequisites for perfSONAR 20 installation bull An overview of the perSONAR 20 installation process bull Detailed instructions of the individual steps of the process
perfSONAR 21 2
perfSONAR 20 Administration Guide Installing perfSONAR 20
2 Installing perfSONAR 20
To install perfSONAR 20 you must
1 Download the perfSONAR 20 bundle into an appropriate location on your system
bull Check the requirements section for the service that you wish to install See ldquo Only Java services can be installed in tomcat
2 perfSONAR 20 Prerequisitesrdquo on page 4
At a minimum check the manual installation requirements section and install any necessary pre-requisites See ldquo221 Manual Installation of pre-requisitesrdquo on page 4
3 Unzip and untar the bundle installer perfsonar-20targz
4 Unsetremove your existing CLASSPATH variable before starting
Make sure that the variable $CLASSPATH is empty You can do this by either removing from your bash_profile file or executing export CLASSPATH= in the command prompt before continuing with the next step
5 Execute the bundle installer using the command perl installpl
a Make sure you are in the perfsonar-bundle directory (for example homeperfsonarperfsonar-20-bundle)
b If perl is not on your PATH you will have to give the complete path to the perl binary - PERL_PATHperl installpl
See ldquo23 Using the perfSONAR 20 Bundle Installerrdquo on page 8
6 Follow the on-screen instructions Before you start installing a service be prepared for the questions that you will be asked
The on-screen dialogue will help you in the installation We recommend that you familiarise yourself with the questions and answers that the installer will ask you when you install a service See ldquo24Interactive Questionsrdquo on page 9
7 At the end of the installation the installer will perform tests on the installation You must verify the results to check your installation was successful
8 The Measurement Archives (RRD and SQL) require some ldquostitchingrdquo after installation See ldquo3 Stitchingrdquo on page 41
perfSONAR 21 3
perfSONAR 20 Administration Guide Installing perfSONAR 20
Note For RRD MA it is important that you set the LD_LIBRARY_PATH variable ideally in the profile where the service is installed This will make sure that whenever you restart tomcat or reboot the machine the variable is applied before tomcat is restarted If this is not done the service will not be able to read the configured RRD Files
21 Points To Consider
bull With perfSONAR 20 you can install any number of services on the same tomcat instance Apart from installations of different service types these installations could also include new instances of the same service type (you can install two SQL MA services on the same tomcat along with any other service type)
bull To make use of this feature be aware that If the service requires XML database (RRD MA SQL MA and LS) please make sure that you
configure each service to use a different username and password Do not use eXist XML Database USERNAMES AND COLLECTIONS across two installations
You must have a different document base for each service To do this choose a different service name than the one already in use (ex XML-LS-11 and XML-LS2-11 if they are on the same tomcat)
bull Only Java services can be installed in tomcat
22 perfSONAR 20 Prerequisites
The perfSONAR bundle contains six services (Web Services Applications) The prerequisites for installing each of these services are different Some of these requirements have to be manually installed while others can by automatically installed during the perfSONAR installation process However you can manually install all the requirements (including the automatic ones) if required
221 Manual Installation of pre-requisites
Depending on the applicationservice you wish to deploy you may be required to manually install some required software
The lists below define general prerequisites for all services followed by specific prerequisites for the individual service
Note Time durations given as rough estimates only and are given only as an indication of the effort involved They do not include stitching or installing operating systems
perfSONAR 21 4
perfSONAR 20 Administration Guide Installing perfSONAR 20
2211 General Requirements
Required for all services
bull Operating System Redhat LinuxFedora Other versions of unix are supported for most services but not all See the requirements for the
service that you want to install Installations on Windows not supported (some services RRD MA for example will not work) wget command should be available on the OS This is required by the installer to download
dependency software
bull Perl - version 561 or higher The Perl Module LWP
2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
bull JAVA (JDK 5 version 15) bull Apache Ant (Version 16x) bull RRDTool to read your RRD files (version 12x)
Make sure you have the following files related to RRDTool on your workstation mdash rrdh - Usually found in $RRDTOOL_HOMEinclude directory mdash Approximately 10 files starting with the name librrd They are usually found in
$RRDTOOL_HOMElib directory
Note During the installation and deployment process you will be required to setup LD_LIBRARY_PATH environment variable It is extremely important that this environment variable is set before every restart of Tomcat We suggest that the LD_LIBRARY_PATH environment variable declaration be added to the profile information of the account where this service is installed The installation process will suggest the value to be used for this variable
2213 SQL Measurement Archive - (Effort ~2 hr)
bull JAVA (JDK 5 - version 15) bull Apache Ant (version 16x) bull MySQL or PostgreSQL Relational Database
Mysql (version 50) PostgreSQL (version 8x)
perfSONAR 21 5
perfSONAR 20 Administration Guide Installing perfSONAR 20
2214 Lookup Service - (Effort ~15 hr)
bull JAVA (JDK 5 - version 15 or later) bull Apache Ant (16x) bull eXist XML Database (version 101 or 111)
Note You can re-use an already installed eXist XML database However if you are installing a new database we recommend installing it in tomcat as a webapp (download war file) Some configuration may be required after installation (see httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS for a short tutorial)
2215 SSHTelnet Measurement Point - (Effort ~20 hr)
bull JAVA (JDK 5 - version 15 or later - available here) bull Apache Ant - version 16x - available here bull You will also need to know the list of routersdevices and the commands on the routers that you
wish to make available via this tool
2216 Command Line Measurement Point - (Effort ~20 hr)
bull JAVA (JDK 5 - version 15 or later) bull Apache Ant (version 16x) bull OWAMP tool (version xx) bull BWCTL tool (version xx) bull Ping tool bull Traceroute tool
2217 BWCTL Measurement Point (Perl)
bull Operating System - Redhat LinuxFedora bull BWCTL MP not testedwont work on other flavors of unix OS bull Perl - version 561 or higher bull BWCTL tool (version 11b or later) bull Iperf tool (version 202 or later) bull Perl Modules that are required to be installed manually
None (unless automatic installations of the required modules fail)
222 Automatic Installation of pre-requisites
The following requirements can be installed automatically
perfSONAR 21 6
perfSONAR 20 Administration Guide Installing perfSONAR 20
Note Even if two services have common requirements it is not necessary to install the same software twice on the same workstation However you may want to record the directory where the software has been automatically installed
2221 RRD Measurement Archive (Java)
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later - available here) bull RRDJtool (as JNI)
2222 SQL Measurement Archive
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2223 Lookup Service
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2224 SSHTelnet Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2225 Command Line Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2226 BWCTL Measurement Point
bull Perl Modules that will be installed automatically Bit-Vector Carp-Clan Compress-Zlib Date-Calc Date-Manip HTML-Parser HTML-Tagset IO-Tty IPC-Run libwww-perl Log-Dispatch
perfSONAR 21 7
perfSONAR 20 Administration Guide Installing perfSONAR 20
Module-Build Params-Validate SOAP-Lite (version 066) URI XML-LibXML XML-LibXML-Common XML-NamespaceSupport XML-SAX XML-Writer XML-Writer-String
23 Using the perfSONAR 20 Bundle Installer
After you have downloaded and unzipped the perfSONAR 20 bundle you can start the installer by
9 Execute the bundle installer using the command perl installpl
a Make sure you are in the perfsonar-bundle directory (for example homeperfsonarperfsonar-20-bundle)
b If perl is not on your PATH you will have to give the complete path to the perl binary - PERL_PATHperl installpl
The installer starts
Note You can exit the installer at any time using the Exit command form the main menu or typing CTRL+C
10 The installer beginning screen displays three options
1 Install a new service Choose this option if you want to install a new service You can also use this option if you have already installed an instance of the same service (for example RRD MA) but would like to install another instance on the same machine
2 Modify or test an existing installation Choose this option to modify configuration details or test existing installations of perfSONAR services This option will not work if you have not already installed any of the services using the perfSONAR 20 bundle
3 Give feedback to the perfSONAR team Your feedback will be sent to us by the installer
If yoursquore installing a new service (and therefore select Option 1)
bull If you chose the first option the bundle installer provides a list of six services that can be installed Simply choose the service that you would like to install from this list
bull The bundle installer automatically downloads installation files for each service and executes the installation steps in sequence for the chosen service
bull Before downloading the installer files for a service the bundle installer will search to see if it can find existing downloads of installation files If you want to install two instances of the same service on the same workstation you can re-use the already downloaded installation files This will not affect the first instance
perfSONAR 21 8
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull If the bundle installer cannot find installation files it will give you the option to either ask it to download the files and install or you can specify an alternate path where the files have been downloaded previously
bull If files have to be downloaded the installer will automatically download and extract the required files It will ask you if you want it to extract to location different from the default one We suggest that you choose the default location
bull After downloading the required files (or accepting an existing installation files directory) the bundle installer will ask you if you want to do a basic installation or an advanced one Choose the basic installation unless you are feeling adventurous See ldquo25 Advanced Installationrdquo on page 38 The steps below are for basic installation
bull Depending on the service chosen you will be asked several questions If you make a mistake at any time quit (CTRL+C) and you can start again (bundle installer will ask you) If you experience some problems or have some questions try out the support pages (FAQs) or contact the mailing list
24 Interactive Questions
The perfSONAR installer prompts you for the information required to install the bundled software
Below are the prompts and questions you need to answer subdivided by service
Note Please review these questions and have all the required information ready to hand before installing the software Explanations for each question are given below and appropriate defaults are included whenever possible
241 RRD Measurement Archive (Java)
2411 Pre-installation
Enter the name of the service [perfSONAR-RRD-MA-20]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-RRD-MA-20
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
perfSONAR 21 9
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [1]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation This is the port number that will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you need another port number then you must also setup Tomcat to use this
new number To do this open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Do you want me to compile rrdjtool library for you (if not you will have to do it manually in
rootperfSONAR-RRD-MA-20perfsonarcontribrrdjtool after pre-install step) (yn)
bull Explanation The service needs the library of rrdjtool which is an interface to RRD files The script can build the library for you if the answer is y
bull Default none
IF answer is y Enter operating system type (linuxlinux-64bitfreebsdsolarisother)
perfSONAR 21 10
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information what OS do you have on your machine You can find a list of accepted operating systems in round brackets
bull Default none
IF answer is y Enter the directory path where header file of the rrdtool (rrdh) can be found [usrlocalrrdtoolinclude]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where the header file of rrdtool is located
bull Default usrlocalrrdtoolinclude bull Recommendation The path in square brackets in only an example
IF answer is y Enter the directory path where library files of the rrdtool (librrd) can be found [usrlocalrrdtoollib]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where library files of rrdtool are located
bull Default usrlocalrrdtoollib bull Recommendation The path in square brackets in only an example
IF answer is y Enter the home directory where the Java is installed (I need the home directory and not the directory where
the executable binary is present) [usrlocaljdk150]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where Java installation is located (rrdjtool is a java library so Java is required for building)
bull Default usrlocaljdk150 bull Recommendation The path in square brackets in only an example
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
perfSONAR 21 11
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter a URL of eXist web application package (exist-101war) [2]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example rrdmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank)
perfSONAR 21 12
perfSONAR 20 Administration Guide Installing perfSONAR 20
everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2412 Configuration
Enter the path of rrd metadata configuration file [rootperfSONAR-RRD-MA-20perfsonarconfrrd-database_TESTxml]
bull Explanation The script asks for the metadata configuration file This file contains the description of measurement data in RRD files If you wanted to use the xml database in the pre-install step then the metadata configuration file will be stored there later on during the Deployment
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in RRD files
bull Default none
Enter location of new RRD files created when measurement data is sent to the service [rootwebapps]
bull Explanation The service can receive messages with measurement data and store them in RRD files Here the script asks for the location where the service will create new RRD files
bull Default ltcurrent_directorygtwebapps
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
2413 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
perfSONAR 21 13
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-RRD-MA-20
[echo] docBase=rootwebappsperfSONAR-RRD-MA-20gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that Tomcat is running
[echo] You can do it using your web browser and connect the address http1270018080
[echo] or looking at Tomcats log file (rootapache-tomcat-607logscatalinaout)
Press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
Do you want me to add new user (provided in the pre-install step) and initiate the xml database eXist (If your eXist
is already configured and initialized for RRD MA answer n But probably its your first run of this installation script
so you have not added this user and initialized the database yet) (yn)
bull Explanation In case of use of the xml database eXist it needs to be set up (this means it must have an account and the metadata configuration specified in the pre-install and configure steps of the installation procedure)
bull Default none bull Recommendation If the xml database already has been set up the answer should be n
perfSONAR 21 14
perfSONAR 20 Administration Guide Installing perfSONAR 20
242 SQL Measurement Archive
2421 Pre-install step
Enter the name of the service [perfSONAR-SQL-MA-10]
bull Explanation - The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-SQL-MA-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [3]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
perfSONAR 21 15
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
IF answer is y Enter a URL of eXist web application package (exist-101war) [4]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
perfSONAR 21 16
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example sqlmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank) everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2422 Configuration
[echo] This service requires access to the relational database
[echo] (mySQL or postgeSQL but others can be used as well)
[echo] Make sure that you have one or install it from scratch
Please do it now and press Enter when finished
bull Explanation The script wants to know if a relational database is installed on the system If you already have one installed just press Enter If not please install one at this point and then press Enter so that the script can continue the installation of the service
bull Default none
[echo] In order to maintain data of utilization metric andor L2 path status metric
[echo] please prepare your relational database
[echo] In case of mySQL use simple script file mysql-sqlma-dbsetupsql
[echo] that you can find in conf directory (rootperfSONAR-SQL-MA-10perfsonarconf)
[echo] of perfSONAR SQL MA installation package
perfSONAR 21 17
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Introduction
5 Upgrading your existing RRD MA and SQL MA metadata configurations 44
6 Upgrading existing (lt20) perfSONAR software 46
7 Uninstallation 47
71 Uninstalling perfSONAR 10 bundle 47
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services 47
73 Uninstalling services bundled in 20 48
731 Uninstalling JAVA Services 48
732 Uninstalling Perl Services 49
74 Uninstalling perfSONAR 20 bundle 49
perfSONAR 21 ii
1 Introduction
This guide describes the installation and configuration processes for perfSONAR 20 It includes
bull A brief introduction to perfSONAR 20 bull Prerequisites needed before installing perfSONAR 20 bull Instructions for the installation and configuration process bull Instructions for implementing Stitching bull Uninstalling perfSONAR 20
11 How To Use This Guide
This guide is aimed at the perfSONAR System Administrator As such it assumes detailed knowledge of operating system software (Windows Linux and Unix) and of the software required for perfSONAR to be installed and operate (see ldquo22 perfSONAR 20 Prerequisitesrdquo on page 4)
Note It is crucial that you are familiar with the operating systems and software requirements before you attempt to install perfSONAR 20
111 Document Conventions
This documentation uses the following typographic conventions for menus commands keyboard keys and items in the program interface
Boldface Commands and names of interface items For example option buttons menu options and so on
Italics Placeholders for information or parameters that you provide For example filename in a procedure means you type the actual name of a file Italics are also used for new terms and the titles of books
hellip gt hellip Used to indicate selecting an option in a hierarchical menu structure For example
perfSONAR 21 1
perfSONAR 20 Administration Guide Introduction
Select Insert gt Picture gt From File
This instructs you to select the Insert option followed by the Picture option and finally the From File option
12 Introducing perfSONAR 20
perfSONAR (Performance focused Service Oriented Network monitoring Architecture) is now released as the perfSONAR 20 software bundle
The bundle has a number of enhancements to the original release
bull Each service is a separate productproject bull The bundle contains only the bundle installer which downloads tar balls of services that the user
wishes to install bull Multiple Services can be installed on same tomcat bull New installer script
Menu based interactive installation on-demand download of services Improved robustness with four steps for installation (pre-install configure deploy test) Java and perl services compatibility Installer written in perl (requires perl) but requires Apache Ant to install Java services
bull Includes four new services and two improved services New Services Command Line MP (Java) SSHTelnet MP (Java) BWCTL MP (Perl) SQL MA
(Java) Improved Services RRD MA (Java) Lookup Service (Java)
bull New features in all Services include Result codes used extensively converted most java exceptions returned to client into xml
result codes Echo functionality on all java services functions as a ping message to the service and helps in
determining status of deployments Automatic download and installation of Tomcat (all Java services) and eXist XML database
(RRD MA and SQL MA only) Lookup Service registrations and keep-alives across all six services
perfSONAR 20 also contains the building blocks for NRENs to provide a Multi-Domain Monitoring (MDM) service
This guide describes the installation process for perSONAR 20 The sections that follow describe
bull The prerequisites for perfSONAR 20 installation bull An overview of the perSONAR 20 installation process bull Detailed instructions of the individual steps of the process
perfSONAR 21 2
perfSONAR 20 Administration Guide Installing perfSONAR 20
2 Installing perfSONAR 20
To install perfSONAR 20 you must
1 Download the perfSONAR 20 bundle into an appropriate location on your system
bull Check the requirements section for the service that you wish to install See ldquo Only Java services can be installed in tomcat
2 perfSONAR 20 Prerequisitesrdquo on page 4
At a minimum check the manual installation requirements section and install any necessary pre-requisites See ldquo221 Manual Installation of pre-requisitesrdquo on page 4
3 Unzip and untar the bundle installer perfsonar-20targz
4 Unsetremove your existing CLASSPATH variable before starting
Make sure that the variable $CLASSPATH is empty You can do this by either removing from your bash_profile file or executing export CLASSPATH= in the command prompt before continuing with the next step
5 Execute the bundle installer using the command perl installpl
a Make sure you are in the perfsonar-bundle directory (for example homeperfsonarperfsonar-20-bundle)
b If perl is not on your PATH you will have to give the complete path to the perl binary - PERL_PATHperl installpl
See ldquo23 Using the perfSONAR 20 Bundle Installerrdquo on page 8
6 Follow the on-screen instructions Before you start installing a service be prepared for the questions that you will be asked
The on-screen dialogue will help you in the installation We recommend that you familiarise yourself with the questions and answers that the installer will ask you when you install a service See ldquo24Interactive Questionsrdquo on page 9
7 At the end of the installation the installer will perform tests on the installation You must verify the results to check your installation was successful
8 The Measurement Archives (RRD and SQL) require some ldquostitchingrdquo after installation See ldquo3 Stitchingrdquo on page 41
perfSONAR 21 3
perfSONAR 20 Administration Guide Installing perfSONAR 20
Note For RRD MA it is important that you set the LD_LIBRARY_PATH variable ideally in the profile where the service is installed This will make sure that whenever you restart tomcat or reboot the machine the variable is applied before tomcat is restarted If this is not done the service will not be able to read the configured RRD Files
21 Points To Consider
bull With perfSONAR 20 you can install any number of services on the same tomcat instance Apart from installations of different service types these installations could also include new instances of the same service type (you can install two SQL MA services on the same tomcat along with any other service type)
bull To make use of this feature be aware that If the service requires XML database (RRD MA SQL MA and LS) please make sure that you
configure each service to use a different username and password Do not use eXist XML Database USERNAMES AND COLLECTIONS across two installations
You must have a different document base for each service To do this choose a different service name than the one already in use (ex XML-LS-11 and XML-LS2-11 if they are on the same tomcat)
bull Only Java services can be installed in tomcat
22 perfSONAR 20 Prerequisites
The perfSONAR bundle contains six services (Web Services Applications) The prerequisites for installing each of these services are different Some of these requirements have to be manually installed while others can by automatically installed during the perfSONAR installation process However you can manually install all the requirements (including the automatic ones) if required
221 Manual Installation of pre-requisites
Depending on the applicationservice you wish to deploy you may be required to manually install some required software
The lists below define general prerequisites for all services followed by specific prerequisites for the individual service
Note Time durations given as rough estimates only and are given only as an indication of the effort involved They do not include stitching or installing operating systems
perfSONAR 21 4
perfSONAR 20 Administration Guide Installing perfSONAR 20
2211 General Requirements
Required for all services
bull Operating System Redhat LinuxFedora Other versions of unix are supported for most services but not all See the requirements for the
service that you want to install Installations on Windows not supported (some services RRD MA for example will not work) wget command should be available on the OS This is required by the installer to download
dependency software
bull Perl - version 561 or higher The Perl Module LWP
2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
bull JAVA (JDK 5 version 15) bull Apache Ant (Version 16x) bull RRDTool to read your RRD files (version 12x)
Make sure you have the following files related to RRDTool on your workstation mdash rrdh - Usually found in $RRDTOOL_HOMEinclude directory mdash Approximately 10 files starting with the name librrd They are usually found in
$RRDTOOL_HOMElib directory
Note During the installation and deployment process you will be required to setup LD_LIBRARY_PATH environment variable It is extremely important that this environment variable is set before every restart of Tomcat We suggest that the LD_LIBRARY_PATH environment variable declaration be added to the profile information of the account where this service is installed The installation process will suggest the value to be used for this variable
2213 SQL Measurement Archive - (Effort ~2 hr)
bull JAVA (JDK 5 - version 15) bull Apache Ant (version 16x) bull MySQL or PostgreSQL Relational Database
Mysql (version 50) PostgreSQL (version 8x)
perfSONAR 21 5
perfSONAR 20 Administration Guide Installing perfSONAR 20
2214 Lookup Service - (Effort ~15 hr)
bull JAVA (JDK 5 - version 15 or later) bull Apache Ant (16x) bull eXist XML Database (version 101 or 111)
Note You can re-use an already installed eXist XML database However if you are installing a new database we recommend installing it in tomcat as a webapp (download war file) Some configuration may be required after installation (see httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS for a short tutorial)
2215 SSHTelnet Measurement Point - (Effort ~20 hr)
bull JAVA (JDK 5 - version 15 or later - available here) bull Apache Ant - version 16x - available here bull You will also need to know the list of routersdevices and the commands on the routers that you
wish to make available via this tool
2216 Command Line Measurement Point - (Effort ~20 hr)
bull JAVA (JDK 5 - version 15 or later) bull Apache Ant (version 16x) bull OWAMP tool (version xx) bull BWCTL tool (version xx) bull Ping tool bull Traceroute tool
2217 BWCTL Measurement Point (Perl)
bull Operating System - Redhat LinuxFedora bull BWCTL MP not testedwont work on other flavors of unix OS bull Perl - version 561 or higher bull BWCTL tool (version 11b or later) bull Iperf tool (version 202 or later) bull Perl Modules that are required to be installed manually
None (unless automatic installations of the required modules fail)
222 Automatic Installation of pre-requisites
The following requirements can be installed automatically
perfSONAR 21 6
perfSONAR 20 Administration Guide Installing perfSONAR 20
Note Even if two services have common requirements it is not necessary to install the same software twice on the same workstation However you may want to record the directory where the software has been automatically installed
2221 RRD Measurement Archive (Java)
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later - available here) bull RRDJtool (as JNI)
2222 SQL Measurement Archive
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2223 Lookup Service
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2224 SSHTelnet Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2225 Command Line Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2226 BWCTL Measurement Point
bull Perl Modules that will be installed automatically Bit-Vector Carp-Clan Compress-Zlib Date-Calc Date-Manip HTML-Parser HTML-Tagset IO-Tty IPC-Run libwww-perl Log-Dispatch
perfSONAR 21 7
perfSONAR 20 Administration Guide Installing perfSONAR 20
Module-Build Params-Validate SOAP-Lite (version 066) URI XML-LibXML XML-LibXML-Common XML-NamespaceSupport XML-SAX XML-Writer XML-Writer-String
23 Using the perfSONAR 20 Bundle Installer
After you have downloaded and unzipped the perfSONAR 20 bundle you can start the installer by
9 Execute the bundle installer using the command perl installpl
a Make sure you are in the perfsonar-bundle directory (for example homeperfsonarperfsonar-20-bundle)
b If perl is not on your PATH you will have to give the complete path to the perl binary - PERL_PATHperl installpl
The installer starts
Note You can exit the installer at any time using the Exit command form the main menu or typing CTRL+C
10 The installer beginning screen displays three options
1 Install a new service Choose this option if you want to install a new service You can also use this option if you have already installed an instance of the same service (for example RRD MA) but would like to install another instance on the same machine
2 Modify or test an existing installation Choose this option to modify configuration details or test existing installations of perfSONAR services This option will not work if you have not already installed any of the services using the perfSONAR 20 bundle
3 Give feedback to the perfSONAR team Your feedback will be sent to us by the installer
If yoursquore installing a new service (and therefore select Option 1)
bull If you chose the first option the bundle installer provides a list of six services that can be installed Simply choose the service that you would like to install from this list
bull The bundle installer automatically downloads installation files for each service and executes the installation steps in sequence for the chosen service
bull Before downloading the installer files for a service the bundle installer will search to see if it can find existing downloads of installation files If you want to install two instances of the same service on the same workstation you can re-use the already downloaded installation files This will not affect the first instance
perfSONAR 21 8
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull If the bundle installer cannot find installation files it will give you the option to either ask it to download the files and install or you can specify an alternate path where the files have been downloaded previously
bull If files have to be downloaded the installer will automatically download and extract the required files It will ask you if you want it to extract to location different from the default one We suggest that you choose the default location
bull After downloading the required files (or accepting an existing installation files directory) the bundle installer will ask you if you want to do a basic installation or an advanced one Choose the basic installation unless you are feeling adventurous See ldquo25 Advanced Installationrdquo on page 38 The steps below are for basic installation
bull Depending on the service chosen you will be asked several questions If you make a mistake at any time quit (CTRL+C) and you can start again (bundle installer will ask you) If you experience some problems or have some questions try out the support pages (FAQs) or contact the mailing list
24 Interactive Questions
The perfSONAR installer prompts you for the information required to install the bundled software
Below are the prompts and questions you need to answer subdivided by service
Note Please review these questions and have all the required information ready to hand before installing the software Explanations for each question are given below and appropriate defaults are included whenever possible
241 RRD Measurement Archive (Java)
2411 Pre-installation
Enter the name of the service [perfSONAR-RRD-MA-20]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-RRD-MA-20
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
perfSONAR 21 9
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [1]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation This is the port number that will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you need another port number then you must also setup Tomcat to use this
new number To do this open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Do you want me to compile rrdjtool library for you (if not you will have to do it manually in
rootperfSONAR-RRD-MA-20perfsonarcontribrrdjtool after pre-install step) (yn)
bull Explanation The service needs the library of rrdjtool which is an interface to RRD files The script can build the library for you if the answer is y
bull Default none
IF answer is y Enter operating system type (linuxlinux-64bitfreebsdsolarisother)
perfSONAR 21 10
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information what OS do you have on your machine You can find a list of accepted operating systems in round brackets
bull Default none
IF answer is y Enter the directory path where header file of the rrdtool (rrdh) can be found [usrlocalrrdtoolinclude]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where the header file of rrdtool is located
bull Default usrlocalrrdtoolinclude bull Recommendation The path in square brackets in only an example
IF answer is y Enter the directory path where library files of the rrdtool (librrd) can be found [usrlocalrrdtoollib]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where library files of rrdtool are located
bull Default usrlocalrrdtoollib bull Recommendation The path in square brackets in only an example
IF answer is y Enter the home directory where the Java is installed (I need the home directory and not the directory where
the executable binary is present) [usrlocaljdk150]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where Java installation is located (rrdjtool is a java library so Java is required for building)
bull Default usrlocaljdk150 bull Recommendation The path in square brackets in only an example
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
perfSONAR 21 11
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter a URL of eXist web application package (exist-101war) [2]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example rrdmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank)
perfSONAR 21 12
perfSONAR 20 Administration Guide Installing perfSONAR 20
everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2412 Configuration
Enter the path of rrd metadata configuration file [rootperfSONAR-RRD-MA-20perfsonarconfrrd-database_TESTxml]
bull Explanation The script asks for the metadata configuration file This file contains the description of measurement data in RRD files If you wanted to use the xml database in the pre-install step then the metadata configuration file will be stored there later on during the Deployment
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in RRD files
bull Default none
Enter location of new RRD files created when measurement data is sent to the service [rootwebapps]
bull Explanation The service can receive messages with measurement data and store them in RRD files Here the script asks for the location where the service will create new RRD files
bull Default ltcurrent_directorygtwebapps
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
2413 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
perfSONAR 21 13
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-RRD-MA-20
[echo] docBase=rootwebappsperfSONAR-RRD-MA-20gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that Tomcat is running
[echo] You can do it using your web browser and connect the address http1270018080
[echo] or looking at Tomcats log file (rootapache-tomcat-607logscatalinaout)
Press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
Do you want me to add new user (provided in the pre-install step) and initiate the xml database eXist (If your eXist
is already configured and initialized for RRD MA answer n But probably its your first run of this installation script
so you have not added this user and initialized the database yet) (yn)
bull Explanation In case of use of the xml database eXist it needs to be set up (this means it must have an account and the metadata configuration specified in the pre-install and configure steps of the installation procedure)
bull Default none bull Recommendation If the xml database already has been set up the answer should be n
perfSONAR 21 14
perfSONAR 20 Administration Guide Installing perfSONAR 20
242 SQL Measurement Archive
2421 Pre-install step
Enter the name of the service [perfSONAR-SQL-MA-10]
bull Explanation - The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-SQL-MA-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [3]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
perfSONAR 21 15
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
IF answer is y Enter a URL of eXist web application package (exist-101war) [4]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
perfSONAR 21 16
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example sqlmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank) everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2422 Configuration
[echo] This service requires access to the relational database
[echo] (mySQL or postgeSQL but others can be used as well)
[echo] Make sure that you have one or install it from scratch
Please do it now and press Enter when finished
bull Explanation The script wants to know if a relational database is installed on the system If you already have one installed just press Enter If not please install one at this point and then press Enter so that the script can continue the installation of the service
bull Default none
[echo] In order to maintain data of utilization metric andor L2 path status metric
[echo] please prepare your relational database
[echo] In case of mySQL use simple script file mysql-sqlma-dbsetupsql
[echo] that you can find in conf directory (rootperfSONAR-SQL-MA-10perfsonarconf)
[echo] of perfSONAR SQL MA installation package
perfSONAR 21 17
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
1 Introduction
This guide describes the installation and configuration processes for perfSONAR 20 It includes
bull A brief introduction to perfSONAR 20 bull Prerequisites needed before installing perfSONAR 20 bull Instructions for the installation and configuration process bull Instructions for implementing Stitching bull Uninstalling perfSONAR 20
11 How To Use This Guide
This guide is aimed at the perfSONAR System Administrator As such it assumes detailed knowledge of operating system software (Windows Linux and Unix) and of the software required for perfSONAR to be installed and operate (see ldquo22 perfSONAR 20 Prerequisitesrdquo on page 4)
Note It is crucial that you are familiar with the operating systems and software requirements before you attempt to install perfSONAR 20
111 Document Conventions
This documentation uses the following typographic conventions for menus commands keyboard keys and items in the program interface
Boldface Commands and names of interface items For example option buttons menu options and so on
Italics Placeholders for information or parameters that you provide For example filename in a procedure means you type the actual name of a file Italics are also used for new terms and the titles of books
hellip gt hellip Used to indicate selecting an option in a hierarchical menu structure For example
perfSONAR 21 1
perfSONAR 20 Administration Guide Introduction
Select Insert gt Picture gt From File
This instructs you to select the Insert option followed by the Picture option and finally the From File option
12 Introducing perfSONAR 20
perfSONAR (Performance focused Service Oriented Network monitoring Architecture) is now released as the perfSONAR 20 software bundle
The bundle has a number of enhancements to the original release
bull Each service is a separate productproject bull The bundle contains only the bundle installer which downloads tar balls of services that the user
wishes to install bull Multiple Services can be installed on same tomcat bull New installer script
Menu based interactive installation on-demand download of services Improved robustness with four steps for installation (pre-install configure deploy test) Java and perl services compatibility Installer written in perl (requires perl) but requires Apache Ant to install Java services
bull Includes four new services and two improved services New Services Command Line MP (Java) SSHTelnet MP (Java) BWCTL MP (Perl) SQL MA
(Java) Improved Services RRD MA (Java) Lookup Service (Java)
bull New features in all Services include Result codes used extensively converted most java exceptions returned to client into xml
result codes Echo functionality on all java services functions as a ping message to the service and helps in
determining status of deployments Automatic download and installation of Tomcat (all Java services) and eXist XML database
(RRD MA and SQL MA only) Lookup Service registrations and keep-alives across all six services
perfSONAR 20 also contains the building blocks for NRENs to provide a Multi-Domain Monitoring (MDM) service
This guide describes the installation process for perSONAR 20 The sections that follow describe
bull The prerequisites for perfSONAR 20 installation bull An overview of the perSONAR 20 installation process bull Detailed instructions of the individual steps of the process
perfSONAR 21 2
perfSONAR 20 Administration Guide Installing perfSONAR 20
2 Installing perfSONAR 20
To install perfSONAR 20 you must
1 Download the perfSONAR 20 bundle into an appropriate location on your system
bull Check the requirements section for the service that you wish to install See ldquo Only Java services can be installed in tomcat
2 perfSONAR 20 Prerequisitesrdquo on page 4
At a minimum check the manual installation requirements section and install any necessary pre-requisites See ldquo221 Manual Installation of pre-requisitesrdquo on page 4
3 Unzip and untar the bundle installer perfsonar-20targz
4 Unsetremove your existing CLASSPATH variable before starting
Make sure that the variable $CLASSPATH is empty You can do this by either removing from your bash_profile file or executing export CLASSPATH= in the command prompt before continuing with the next step
5 Execute the bundle installer using the command perl installpl
a Make sure you are in the perfsonar-bundle directory (for example homeperfsonarperfsonar-20-bundle)
b If perl is not on your PATH you will have to give the complete path to the perl binary - PERL_PATHperl installpl
See ldquo23 Using the perfSONAR 20 Bundle Installerrdquo on page 8
6 Follow the on-screen instructions Before you start installing a service be prepared for the questions that you will be asked
The on-screen dialogue will help you in the installation We recommend that you familiarise yourself with the questions and answers that the installer will ask you when you install a service See ldquo24Interactive Questionsrdquo on page 9
7 At the end of the installation the installer will perform tests on the installation You must verify the results to check your installation was successful
8 The Measurement Archives (RRD and SQL) require some ldquostitchingrdquo after installation See ldquo3 Stitchingrdquo on page 41
perfSONAR 21 3
perfSONAR 20 Administration Guide Installing perfSONAR 20
Note For RRD MA it is important that you set the LD_LIBRARY_PATH variable ideally in the profile where the service is installed This will make sure that whenever you restart tomcat or reboot the machine the variable is applied before tomcat is restarted If this is not done the service will not be able to read the configured RRD Files
21 Points To Consider
bull With perfSONAR 20 you can install any number of services on the same tomcat instance Apart from installations of different service types these installations could also include new instances of the same service type (you can install two SQL MA services on the same tomcat along with any other service type)
bull To make use of this feature be aware that If the service requires XML database (RRD MA SQL MA and LS) please make sure that you
configure each service to use a different username and password Do not use eXist XML Database USERNAMES AND COLLECTIONS across two installations
You must have a different document base for each service To do this choose a different service name than the one already in use (ex XML-LS-11 and XML-LS2-11 if they are on the same tomcat)
bull Only Java services can be installed in tomcat
22 perfSONAR 20 Prerequisites
The perfSONAR bundle contains six services (Web Services Applications) The prerequisites for installing each of these services are different Some of these requirements have to be manually installed while others can by automatically installed during the perfSONAR installation process However you can manually install all the requirements (including the automatic ones) if required
221 Manual Installation of pre-requisites
Depending on the applicationservice you wish to deploy you may be required to manually install some required software
The lists below define general prerequisites for all services followed by specific prerequisites for the individual service
Note Time durations given as rough estimates only and are given only as an indication of the effort involved They do not include stitching or installing operating systems
perfSONAR 21 4
perfSONAR 20 Administration Guide Installing perfSONAR 20
2211 General Requirements
Required for all services
bull Operating System Redhat LinuxFedora Other versions of unix are supported for most services but not all See the requirements for the
service that you want to install Installations on Windows not supported (some services RRD MA for example will not work) wget command should be available on the OS This is required by the installer to download
dependency software
bull Perl - version 561 or higher The Perl Module LWP
2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
bull JAVA (JDK 5 version 15) bull Apache Ant (Version 16x) bull RRDTool to read your RRD files (version 12x)
Make sure you have the following files related to RRDTool on your workstation mdash rrdh - Usually found in $RRDTOOL_HOMEinclude directory mdash Approximately 10 files starting with the name librrd They are usually found in
$RRDTOOL_HOMElib directory
Note During the installation and deployment process you will be required to setup LD_LIBRARY_PATH environment variable It is extremely important that this environment variable is set before every restart of Tomcat We suggest that the LD_LIBRARY_PATH environment variable declaration be added to the profile information of the account where this service is installed The installation process will suggest the value to be used for this variable
2213 SQL Measurement Archive - (Effort ~2 hr)
bull JAVA (JDK 5 - version 15) bull Apache Ant (version 16x) bull MySQL or PostgreSQL Relational Database
Mysql (version 50) PostgreSQL (version 8x)
perfSONAR 21 5
perfSONAR 20 Administration Guide Installing perfSONAR 20
2214 Lookup Service - (Effort ~15 hr)
bull JAVA (JDK 5 - version 15 or later) bull Apache Ant (16x) bull eXist XML Database (version 101 or 111)
Note You can re-use an already installed eXist XML database However if you are installing a new database we recommend installing it in tomcat as a webapp (download war file) Some configuration may be required after installation (see httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS for a short tutorial)
2215 SSHTelnet Measurement Point - (Effort ~20 hr)
bull JAVA (JDK 5 - version 15 or later - available here) bull Apache Ant - version 16x - available here bull You will also need to know the list of routersdevices and the commands on the routers that you
wish to make available via this tool
2216 Command Line Measurement Point - (Effort ~20 hr)
bull JAVA (JDK 5 - version 15 or later) bull Apache Ant (version 16x) bull OWAMP tool (version xx) bull BWCTL tool (version xx) bull Ping tool bull Traceroute tool
2217 BWCTL Measurement Point (Perl)
bull Operating System - Redhat LinuxFedora bull BWCTL MP not testedwont work on other flavors of unix OS bull Perl - version 561 or higher bull BWCTL tool (version 11b or later) bull Iperf tool (version 202 or later) bull Perl Modules that are required to be installed manually
None (unless automatic installations of the required modules fail)
222 Automatic Installation of pre-requisites
The following requirements can be installed automatically
perfSONAR 21 6
perfSONAR 20 Administration Guide Installing perfSONAR 20
Note Even if two services have common requirements it is not necessary to install the same software twice on the same workstation However you may want to record the directory where the software has been automatically installed
2221 RRD Measurement Archive (Java)
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later - available here) bull RRDJtool (as JNI)
2222 SQL Measurement Archive
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2223 Lookup Service
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2224 SSHTelnet Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2225 Command Line Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2226 BWCTL Measurement Point
bull Perl Modules that will be installed automatically Bit-Vector Carp-Clan Compress-Zlib Date-Calc Date-Manip HTML-Parser HTML-Tagset IO-Tty IPC-Run libwww-perl Log-Dispatch
perfSONAR 21 7
perfSONAR 20 Administration Guide Installing perfSONAR 20
Module-Build Params-Validate SOAP-Lite (version 066) URI XML-LibXML XML-LibXML-Common XML-NamespaceSupport XML-SAX XML-Writer XML-Writer-String
23 Using the perfSONAR 20 Bundle Installer
After you have downloaded and unzipped the perfSONAR 20 bundle you can start the installer by
9 Execute the bundle installer using the command perl installpl
a Make sure you are in the perfsonar-bundle directory (for example homeperfsonarperfsonar-20-bundle)
b If perl is not on your PATH you will have to give the complete path to the perl binary - PERL_PATHperl installpl
The installer starts
Note You can exit the installer at any time using the Exit command form the main menu or typing CTRL+C
10 The installer beginning screen displays three options
1 Install a new service Choose this option if you want to install a new service You can also use this option if you have already installed an instance of the same service (for example RRD MA) but would like to install another instance on the same machine
2 Modify or test an existing installation Choose this option to modify configuration details or test existing installations of perfSONAR services This option will not work if you have not already installed any of the services using the perfSONAR 20 bundle
3 Give feedback to the perfSONAR team Your feedback will be sent to us by the installer
If yoursquore installing a new service (and therefore select Option 1)
bull If you chose the first option the bundle installer provides a list of six services that can be installed Simply choose the service that you would like to install from this list
bull The bundle installer automatically downloads installation files for each service and executes the installation steps in sequence for the chosen service
bull Before downloading the installer files for a service the bundle installer will search to see if it can find existing downloads of installation files If you want to install two instances of the same service on the same workstation you can re-use the already downloaded installation files This will not affect the first instance
perfSONAR 21 8
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull If the bundle installer cannot find installation files it will give you the option to either ask it to download the files and install or you can specify an alternate path where the files have been downloaded previously
bull If files have to be downloaded the installer will automatically download and extract the required files It will ask you if you want it to extract to location different from the default one We suggest that you choose the default location
bull After downloading the required files (or accepting an existing installation files directory) the bundle installer will ask you if you want to do a basic installation or an advanced one Choose the basic installation unless you are feeling adventurous See ldquo25 Advanced Installationrdquo on page 38 The steps below are for basic installation
bull Depending on the service chosen you will be asked several questions If you make a mistake at any time quit (CTRL+C) and you can start again (bundle installer will ask you) If you experience some problems or have some questions try out the support pages (FAQs) or contact the mailing list
24 Interactive Questions
The perfSONAR installer prompts you for the information required to install the bundled software
Below are the prompts and questions you need to answer subdivided by service
Note Please review these questions and have all the required information ready to hand before installing the software Explanations for each question are given below and appropriate defaults are included whenever possible
241 RRD Measurement Archive (Java)
2411 Pre-installation
Enter the name of the service [perfSONAR-RRD-MA-20]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-RRD-MA-20
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
perfSONAR 21 9
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [1]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation This is the port number that will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you need another port number then you must also setup Tomcat to use this
new number To do this open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Do you want me to compile rrdjtool library for you (if not you will have to do it manually in
rootperfSONAR-RRD-MA-20perfsonarcontribrrdjtool after pre-install step) (yn)
bull Explanation The service needs the library of rrdjtool which is an interface to RRD files The script can build the library for you if the answer is y
bull Default none
IF answer is y Enter operating system type (linuxlinux-64bitfreebsdsolarisother)
perfSONAR 21 10
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information what OS do you have on your machine You can find a list of accepted operating systems in round brackets
bull Default none
IF answer is y Enter the directory path where header file of the rrdtool (rrdh) can be found [usrlocalrrdtoolinclude]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where the header file of rrdtool is located
bull Default usrlocalrrdtoolinclude bull Recommendation The path in square brackets in only an example
IF answer is y Enter the directory path where library files of the rrdtool (librrd) can be found [usrlocalrrdtoollib]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where library files of rrdtool are located
bull Default usrlocalrrdtoollib bull Recommendation The path in square brackets in only an example
IF answer is y Enter the home directory where the Java is installed (I need the home directory and not the directory where
the executable binary is present) [usrlocaljdk150]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where Java installation is located (rrdjtool is a java library so Java is required for building)
bull Default usrlocaljdk150 bull Recommendation The path in square brackets in only an example
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
perfSONAR 21 11
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter a URL of eXist web application package (exist-101war) [2]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example rrdmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank)
perfSONAR 21 12
perfSONAR 20 Administration Guide Installing perfSONAR 20
everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2412 Configuration
Enter the path of rrd metadata configuration file [rootperfSONAR-RRD-MA-20perfsonarconfrrd-database_TESTxml]
bull Explanation The script asks for the metadata configuration file This file contains the description of measurement data in RRD files If you wanted to use the xml database in the pre-install step then the metadata configuration file will be stored there later on during the Deployment
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in RRD files
bull Default none
Enter location of new RRD files created when measurement data is sent to the service [rootwebapps]
bull Explanation The service can receive messages with measurement data and store them in RRD files Here the script asks for the location where the service will create new RRD files
bull Default ltcurrent_directorygtwebapps
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
2413 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
perfSONAR 21 13
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-RRD-MA-20
[echo] docBase=rootwebappsperfSONAR-RRD-MA-20gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that Tomcat is running
[echo] You can do it using your web browser and connect the address http1270018080
[echo] or looking at Tomcats log file (rootapache-tomcat-607logscatalinaout)
Press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
Do you want me to add new user (provided in the pre-install step) and initiate the xml database eXist (If your eXist
is already configured and initialized for RRD MA answer n But probably its your first run of this installation script
so you have not added this user and initialized the database yet) (yn)
bull Explanation In case of use of the xml database eXist it needs to be set up (this means it must have an account and the metadata configuration specified in the pre-install and configure steps of the installation procedure)
bull Default none bull Recommendation If the xml database already has been set up the answer should be n
perfSONAR 21 14
perfSONAR 20 Administration Guide Installing perfSONAR 20
242 SQL Measurement Archive
2421 Pre-install step
Enter the name of the service [perfSONAR-SQL-MA-10]
bull Explanation - The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-SQL-MA-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [3]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
perfSONAR 21 15
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
IF answer is y Enter a URL of eXist web application package (exist-101war) [4]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
perfSONAR 21 16
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example sqlmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank) everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2422 Configuration
[echo] This service requires access to the relational database
[echo] (mySQL or postgeSQL but others can be used as well)
[echo] Make sure that you have one or install it from scratch
Please do it now and press Enter when finished
bull Explanation The script wants to know if a relational database is installed on the system If you already have one installed just press Enter If not please install one at this point and then press Enter so that the script can continue the installation of the service
bull Default none
[echo] In order to maintain data of utilization metric andor L2 path status metric
[echo] please prepare your relational database
[echo] In case of mySQL use simple script file mysql-sqlma-dbsetupsql
[echo] that you can find in conf directory (rootperfSONAR-SQL-MA-10perfsonarconf)
[echo] of perfSONAR SQL MA installation package
perfSONAR 21 17
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Introduction
Select Insert gt Picture gt From File
This instructs you to select the Insert option followed by the Picture option and finally the From File option
12 Introducing perfSONAR 20
perfSONAR (Performance focused Service Oriented Network monitoring Architecture) is now released as the perfSONAR 20 software bundle
The bundle has a number of enhancements to the original release
bull Each service is a separate productproject bull The bundle contains only the bundle installer which downloads tar balls of services that the user
wishes to install bull Multiple Services can be installed on same tomcat bull New installer script
Menu based interactive installation on-demand download of services Improved robustness with four steps for installation (pre-install configure deploy test) Java and perl services compatibility Installer written in perl (requires perl) but requires Apache Ant to install Java services
bull Includes four new services and two improved services New Services Command Line MP (Java) SSHTelnet MP (Java) BWCTL MP (Perl) SQL MA
(Java) Improved Services RRD MA (Java) Lookup Service (Java)
bull New features in all Services include Result codes used extensively converted most java exceptions returned to client into xml
result codes Echo functionality on all java services functions as a ping message to the service and helps in
determining status of deployments Automatic download and installation of Tomcat (all Java services) and eXist XML database
(RRD MA and SQL MA only) Lookup Service registrations and keep-alives across all six services
perfSONAR 20 also contains the building blocks for NRENs to provide a Multi-Domain Monitoring (MDM) service
This guide describes the installation process for perSONAR 20 The sections that follow describe
bull The prerequisites for perfSONAR 20 installation bull An overview of the perSONAR 20 installation process bull Detailed instructions of the individual steps of the process
perfSONAR 21 2
perfSONAR 20 Administration Guide Installing perfSONAR 20
2 Installing perfSONAR 20
To install perfSONAR 20 you must
1 Download the perfSONAR 20 bundle into an appropriate location on your system
bull Check the requirements section for the service that you wish to install See ldquo Only Java services can be installed in tomcat
2 perfSONAR 20 Prerequisitesrdquo on page 4
At a minimum check the manual installation requirements section and install any necessary pre-requisites See ldquo221 Manual Installation of pre-requisitesrdquo on page 4
3 Unzip and untar the bundle installer perfsonar-20targz
4 Unsetremove your existing CLASSPATH variable before starting
Make sure that the variable $CLASSPATH is empty You can do this by either removing from your bash_profile file or executing export CLASSPATH= in the command prompt before continuing with the next step
5 Execute the bundle installer using the command perl installpl
a Make sure you are in the perfsonar-bundle directory (for example homeperfsonarperfsonar-20-bundle)
b If perl is not on your PATH you will have to give the complete path to the perl binary - PERL_PATHperl installpl
See ldquo23 Using the perfSONAR 20 Bundle Installerrdquo on page 8
6 Follow the on-screen instructions Before you start installing a service be prepared for the questions that you will be asked
The on-screen dialogue will help you in the installation We recommend that you familiarise yourself with the questions and answers that the installer will ask you when you install a service See ldquo24Interactive Questionsrdquo on page 9
7 At the end of the installation the installer will perform tests on the installation You must verify the results to check your installation was successful
8 The Measurement Archives (RRD and SQL) require some ldquostitchingrdquo after installation See ldquo3 Stitchingrdquo on page 41
perfSONAR 21 3
perfSONAR 20 Administration Guide Installing perfSONAR 20
Note For RRD MA it is important that you set the LD_LIBRARY_PATH variable ideally in the profile where the service is installed This will make sure that whenever you restart tomcat or reboot the machine the variable is applied before tomcat is restarted If this is not done the service will not be able to read the configured RRD Files
21 Points To Consider
bull With perfSONAR 20 you can install any number of services on the same tomcat instance Apart from installations of different service types these installations could also include new instances of the same service type (you can install two SQL MA services on the same tomcat along with any other service type)
bull To make use of this feature be aware that If the service requires XML database (RRD MA SQL MA and LS) please make sure that you
configure each service to use a different username and password Do not use eXist XML Database USERNAMES AND COLLECTIONS across two installations
You must have a different document base for each service To do this choose a different service name than the one already in use (ex XML-LS-11 and XML-LS2-11 if they are on the same tomcat)
bull Only Java services can be installed in tomcat
22 perfSONAR 20 Prerequisites
The perfSONAR bundle contains six services (Web Services Applications) The prerequisites for installing each of these services are different Some of these requirements have to be manually installed while others can by automatically installed during the perfSONAR installation process However you can manually install all the requirements (including the automatic ones) if required
221 Manual Installation of pre-requisites
Depending on the applicationservice you wish to deploy you may be required to manually install some required software
The lists below define general prerequisites for all services followed by specific prerequisites for the individual service
Note Time durations given as rough estimates only and are given only as an indication of the effort involved They do not include stitching or installing operating systems
perfSONAR 21 4
perfSONAR 20 Administration Guide Installing perfSONAR 20
2211 General Requirements
Required for all services
bull Operating System Redhat LinuxFedora Other versions of unix are supported for most services but not all See the requirements for the
service that you want to install Installations on Windows not supported (some services RRD MA for example will not work) wget command should be available on the OS This is required by the installer to download
dependency software
bull Perl - version 561 or higher The Perl Module LWP
2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
bull JAVA (JDK 5 version 15) bull Apache Ant (Version 16x) bull RRDTool to read your RRD files (version 12x)
Make sure you have the following files related to RRDTool on your workstation mdash rrdh - Usually found in $RRDTOOL_HOMEinclude directory mdash Approximately 10 files starting with the name librrd They are usually found in
$RRDTOOL_HOMElib directory
Note During the installation and deployment process you will be required to setup LD_LIBRARY_PATH environment variable It is extremely important that this environment variable is set before every restart of Tomcat We suggest that the LD_LIBRARY_PATH environment variable declaration be added to the profile information of the account where this service is installed The installation process will suggest the value to be used for this variable
2213 SQL Measurement Archive - (Effort ~2 hr)
bull JAVA (JDK 5 - version 15) bull Apache Ant (version 16x) bull MySQL or PostgreSQL Relational Database
Mysql (version 50) PostgreSQL (version 8x)
perfSONAR 21 5
perfSONAR 20 Administration Guide Installing perfSONAR 20
2214 Lookup Service - (Effort ~15 hr)
bull JAVA (JDK 5 - version 15 or later) bull Apache Ant (16x) bull eXist XML Database (version 101 or 111)
Note You can re-use an already installed eXist XML database However if you are installing a new database we recommend installing it in tomcat as a webapp (download war file) Some configuration may be required after installation (see httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS for a short tutorial)
2215 SSHTelnet Measurement Point - (Effort ~20 hr)
bull JAVA (JDK 5 - version 15 or later - available here) bull Apache Ant - version 16x - available here bull You will also need to know the list of routersdevices and the commands on the routers that you
wish to make available via this tool
2216 Command Line Measurement Point - (Effort ~20 hr)
bull JAVA (JDK 5 - version 15 or later) bull Apache Ant (version 16x) bull OWAMP tool (version xx) bull BWCTL tool (version xx) bull Ping tool bull Traceroute tool
2217 BWCTL Measurement Point (Perl)
bull Operating System - Redhat LinuxFedora bull BWCTL MP not testedwont work on other flavors of unix OS bull Perl - version 561 or higher bull BWCTL tool (version 11b or later) bull Iperf tool (version 202 or later) bull Perl Modules that are required to be installed manually
None (unless automatic installations of the required modules fail)
222 Automatic Installation of pre-requisites
The following requirements can be installed automatically
perfSONAR 21 6
perfSONAR 20 Administration Guide Installing perfSONAR 20
Note Even if two services have common requirements it is not necessary to install the same software twice on the same workstation However you may want to record the directory where the software has been automatically installed
2221 RRD Measurement Archive (Java)
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later - available here) bull RRDJtool (as JNI)
2222 SQL Measurement Archive
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2223 Lookup Service
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2224 SSHTelnet Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2225 Command Line Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2226 BWCTL Measurement Point
bull Perl Modules that will be installed automatically Bit-Vector Carp-Clan Compress-Zlib Date-Calc Date-Manip HTML-Parser HTML-Tagset IO-Tty IPC-Run libwww-perl Log-Dispatch
perfSONAR 21 7
perfSONAR 20 Administration Guide Installing perfSONAR 20
Module-Build Params-Validate SOAP-Lite (version 066) URI XML-LibXML XML-LibXML-Common XML-NamespaceSupport XML-SAX XML-Writer XML-Writer-String
23 Using the perfSONAR 20 Bundle Installer
After you have downloaded and unzipped the perfSONAR 20 bundle you can start the installer by
9 Execute the bundle installer using the command perl installpl
a Make sure you are in the perfsonar-bundle directory (for example homeperfsonarperfsonar-20-bundle)
b If perl is not on your PATH you will have to give the complete path to the perl binary - PERL_PATHperl installpl
The installer starts
Note You can exit the installer at any time using the Exit command form the main menu or typing CTRL+C
10 The installer beginning screen displays three options
1 Install a new service Choose this option if you want to install a new service You can also use this option if you have already installed an instance of the same service (for example RRD MA) but would like to install another instance on the same machine
2 Modify or test an existing installation Choose this option to modify configuration details or test existing installations of perfSONAR services This option will not work if you have not already installed any of the services using the perfSONAR 20 bundle
3 Give feedback to the perfSONAR team Your feedback will be sent to us by the installer
If yoursquore installing a new service (and therefore select Option 1)
bull If you chose the first option the bundle installer provides a list of six services that can be installed Simply choose the service that you would like to install from this list
bull The bundle installer automatically downloads installation files for each service and executes the installation steps in sequence for the chosen service
bull Before downloading the installer files for a service the bundle installer will search to see if it can find existing downloads of installation files If you want to install two instances of the same service on the same workstation you can re-use the already downloaded installation files This will not affect the first instance
perfSONAR 21 8
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull If the bundle installer cannot find installation files it will give you the option to either ask it to download the files and install or you can specify an alternate path where the files have been downloaded previously
bull If files have to be downloaded the installer will automatically download and extract the required files It will ask you if you want it to extract to location different from the default one We suggest that you choose the default location
bull After downloading the required files (or accepting an existing installation files directory) the bundle installer will ask you if you want to do a basic installation or an advanced one Choose the basic installation unless you are feeling adventurous See ldquo25 Advanced Installationrdquo on page 38 The steps below are for basic installation
bull Depending on the service chosen you will be asked several questions If you make a mistake at any time quit (CTRL+C) and you can start again (bundle installer will ask you) If you experience some problems or have some questions try out the support pages (FAQs) or contact the mailing list
24 Interactive Questions
The perfSONAR installer prompts you for the information required to install the bundled software
Below are the prompts and questions you need to answer subdivided by service
Note Please review these questions and have all the required information ready to hand before installing the software Explanations for each question are given below and appropriate defaults are included whenever possible
241 RRD Measurement Archive (Java)
2411 Pre-installation
Enter the name of the service [perfSONAR-RRD-MA-20]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-RRD-MA-20
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
perfSONAR 21 9
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [1]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation This is the port number that will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you need another port number then you must also setup Tomcat to use this
new number To do this open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Do you want me to compile rrdjtool library for you (if not you will have to do it manually in
rootperfSONAR-RRD-MA-20perfsonarcontribrrdjtool after pre-install step) (yn)
bull Explanation The service needs the library of rrdjtool which is an interface to RRD files The script can build the library for you if the answer is y
bull Default none
IF answer is y Enter operating system type (linuxlinux-64bitfreebsdsolarisother)
perfSONAR 21 10
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information what OS do you have on your machine You can find a list of accepted operating systems in round brackets
bull Default none
IF answer is y Enter the directory path where header file of the rrdtool (rrdh) can be found [usrlocalrrdtoolinclude]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where the header file of rrdtool is located
bull Default usrlocalrrdtoolinclude bull Recommendation The path in square brackets in only an example
IF answer is y Enter the directory path where library files of the rrdtool (librrd) can be found [usrlocalrrdtoollib]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where library files of rrdtool are located
bull Default usrlocalrrdtoollib bull Recommendation The path in square brackets in only an example
IF answer is y Enter the home directory where the Java is installed (I need the home directory and not the directory where
the executable binary is present) [usrlocaljdk150]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where Java installation is located (rrdjtool is a java library so Java is required for building)
bull Default usrlocaljdk150 bull Recommendation The path in square brackets in only an example
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
perfSONAR 21 11
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter a URL of eXist web application package (exist-101war) [2]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example rrdmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank)
perfSONAR 21 12
perfSONAR 20 Administration Guide Installing perfSONAR 20
everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2412 Configuration
Enter the path of rrd metadata configuration file [rootperfSONAR-RRD-MA-20perfsonarconfrrd-database_TESTxml]
bull Explanation The script asks for the metadata configuration file This file contains the description of measurement data in RRD files If you wanted to use the xml database in the pre-install step then the metadata configuration file will be stored there later on during the Deployment
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in RRD files
bull Default none
Enter location of new RRD files created when measurement data is sent to the service [rootwebapps]
bull Explanation The service can receive messages with measurement data and store them in RRD files Here the script asks for the location where the service will create new RRD files
bull Default ltcurrent_directorygtwebapps
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
2413 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
perfSONAR 21 13
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-RRD-MA-20
[echo] docBase=rootwebappsperfSONAR-RRD-MA-20gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that Tomcat is running
[echo] You can do it using your web browser and connect the address http1270018080
[echo] or looking at Tomcats log file (rootapache-tomcat-607logscatalinaout)
Press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
Do you want me to add new user (provided in the pre-install step) and initiate the xml database eXist (If your eXist
is already configured and initialized for RRD MA answer n But probably its your first run of this installation script
so you have not added this user and initialized the database yet) (yn)
bull Explanation In case of use of the xml database eXist it needs to be set up (this means it must have an account and the metadata configuration specified in the pre-install and configure steps of the installation procedure)
bull Default none bull Recommendation If the xml database already has been set up the answer should be n
perfSONAR 21 14
perfSONAR 20 Administration Guide Installing perfSONAR 20
242 SQL Measurement Archive
2421 Pre-install step
Enter the name of the service [perfSONAR-SQL-MA-10]
bull Explanation - The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-SQL-MA-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [3]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
perfSONAR 21 15
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
IF answer is y Enter a URL of eXist web application package (exist-101war) [4]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
perfSONAR 21 16
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example sqlmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank) everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2422 Configuration
[echo] This service requires access to the relational database
[echo] (mySQL or postgeSQL but others can be used as well)
[echo] Make sure that you have one or install it from scratch
Please do it now and press Enter when finished
bull Explanation The script wants to know if a relational database is installed on the system If you already have one installed just press Enter If not please install one at this point and then press Enter so that the script can continue the installation of the service
bull Default none
[echo] In order to maintain data of utilization metric andor L2 path status metric
[echo] please prepare your relational database
[echo] In case of mySQL use simple script file mysql-sqlma-dbsetupsql
[echo] that you can find in conf directory (rootperfSONAR-SQL-MA-10perfsonarconf)
[echo] of perfSONAR SQL MA installation package
perfSONAR 21 17
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
2 Installing perfSONAR 20
To install perfSONAR 20 you must
1 Download the perfSONAR 20 bundle into an appropriate location on your system
bull Check the requirements section for the service that you wish to install See ldquo Only Java services can be installed in tomcat
2 perfSONAR 20 Prerequisitesrdquo on page 4
At a minimum check the manual installation requirements section and install any necessary pre-requisites See ldquo221 Manual Installation of pre-requisitesrdquo on page 4
3 Unzip and untar the bundle installer perfsonar-20targz
4 Unsetremove your existing CLASSPATH variable before starting
Make sure that the variable $CLASSPATH is empty You can do this by either removing from your bash_profile file or executing export CLASSPATH= in the command prompt before continuing with the next step
5 Execute the bundle installer using the command perl installpl
a Make sure you are in the perfsonar-bundle directory (for example homeperfsonarperfsonar-20-bundle)
b If perl is not on your PATH you will have to give the complete path to the perl binary - PERL_PATHperl installpl
See ldquo23 Using the perfSONAR 20 Bundle Installerrdquo on page 8
6 Follow the on-screen instructions Before you start installing a service be prepared for the questions that you will be asked
The on-screen dialogue will help you in the installation We recommend that you familiarise yourself with the questions and answers that the installer will ask you when you install a service See ldquo24Interactive Questionsrdquo on page 9
7 At the end of the installation the installer will perform tests on the installation You must verify the results to check your installation was successful
8 The Measurement Archives (RRD and SQL) require some ldquostitchingrdquo after installation See ldquo3 Stitchingrdquo on page 41
perfSONAR 21 3
perfSONAR 20 Administration Guide Installing perfSONAR 20
Note For RRD MA it is important that you set the LD_LIBRARY_PATH variable ideally in the profile where the service is installed This will make sure that whenever you restart tomcat or reboot the machine the variable is applied before tomcat is restarted If this is not done the service will not be able to read the configured RRD Files
21 Points To Consider
bull With perfSONAR 20 you can install any number of services on the same tomcat instance Apart from installations of different service types these installations could also include new instances of the same service type (you can install two SQL MA services on the same tomcat along with any other service type)
bull To make use of this feature be aware that If the service requires XML database (RRD MA SQL MA and LS) please make sure that you
configure each service to use a different username and password Do not use eXist XML Database USERNAMES AND COLLECTIONS across two installations
You must have a different document base for each service To do this choose a different service name than the one already in use (ex XML-LS-11 and XML-LS2-11 if they are on the same tomcat)
bull Only Java services can be installed in tomcat
22 perfSONAR 20 Prerequisites
The perfSONAR bundle contains six services (Web Services Applications) The prerequisites for installing each of these services are different Some of these requirements have to be manually installed while others can by automatically installed during the perfSONAR installation process However you can manually install all the requirements (including the automatic ones) if required
221 Manual Installation of pre-requisites
Depending on the applicationservice you wish to deploy you may be required to manually install some required software
The lists below define general prerequisites for all services followed by specific prerequisites for the individual service
Note Time durations given as rough estimates only and are given only as an indication of the effort involved They do not include stitching or installing operating systems
perfSONAR 21 4
perfSONAR 20 Administration Guide Installing perfSONAR 20
2211 General Requirements
Required for all services
bull Operating System Redhat LinuxFedora Other versions of unix are supported for most services but not all See the requirements for the
service that you want to install Installations on Windows not supported (some services RRD MA for example will not work) wget command should be available on the OS This is required by the installer to download
dependency software
bull Perl - version 561 or higher The Perl Module LWP
2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
bull JAVA (JDK 5 version 15) bull Apache Ant (Version 16x) bull RRDTool to read your RRD files (version 12x)
Make sure you have the following files related to RRDTool on your workstation mdash rrdh - Usually found in $RRDTOOL_HOMEinclude directory mdash Approximately 10 files starting with the name librrd They are usually found in
$RRDTOOL_HOMElib directory
Note During the installation and deployment process you will be required to setup LD_LIBRARY_PATH environment variable It is extremely important that this environment variable is set before every restart of Tomcat We suggest that the LD_LIBRARY_PATH environment variable declaration be added to the profile information of the account where this service is installed The installation process will suggest the value to be used for this variable
2213 SQL Measurement Archive - (Effort ~2 hr)
bull JAVA (JDK 5 - version 15) bull Apache Ant (version 16x) bull MySQL or PostgreSQL Relational Database
Mysql (version 50) PostgreSQL (version 8x)
perfSONAR 21 5
perfSONAR 20 Administration Guide Installing perfSONAR 20
2214 Lookup Service - (Effort ~15 hr)
bull JAVA (JDK 5 - version 15 or later) bull Apache Ant (16x) bull eXist XML Database (version 101 or 111)
Note You can re-use an already installed eXist XML database However if you are installing a new database we recommend installing it in tomcat as a webapp (download war file) Some configuration may be required after installation (see httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS for a short tutorial)
2215 SSHTelnet Measurement Point - (Effort ~20 hr)
bull JAVA (JDK 5 - version 15 or later - available here) bull Apache Ant - version 16x - available here bull You will also need to know the list of routersdevices and the commands on the routers that you
wish to make available via this tool
2216 Command Line Measurement Point - (Effort ~20 hr)
bull JAVA (JDK 5 - version 15 or later) bull Apache Ant (version 16x) bull OWAMP tool (version xx) bull BWCTL tool (version xx) bull Ping tool bull Traceroute tool
2217 BWCTL Measurement Point (Perl)
bull Operating System - Redhat LinuxFedora bull BWCTL MP not testedwont work on other flavors of unix OS bull Perl - version 561 or higher bull BWCTL tool (version 11b or later) bull Iperf tool (version 202 or later) bull Perl Modules that are required to be installed manually
None (unless automatic installations of the required modules fail)
222 Automatic Installation of pre-requisites
The following requirements can be installed automatically
perfSONAR 21 6
perfSONAR 20 Administration Guide Installing perfSONAR 20
Note Even if two services have common requirements it is not necessary to install the same software twice on the same workstation However you may want to record the directory where the software has been automatically installed
2221 RRD Measurement Archive (Java)
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later - available here) bull RRDJtool (as JNI)
2222 SQL Measurement Archive
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2223 Lookup Service
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2224 SSHTelnet Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2225 Command Line Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2226 BWCTL Measurement Point
bull Perl Modules that will be installed automatically Bit-Vector Carp-Clan Compress-Zlib Date-Calc Date-Manip HTML-Parser HTML-Tagset IO-Tty IPC-Run libwww-perl Log-Dispatch
perfSONAR 21 7
perfSONAR 20 Administration Guide Installing perfSONAR 20
Module-Build Params-Validate SOAP-Lite (version 066) URI XML-LibXML XML-LibXML-Common XML-NamespaceSupport XML-SAX XML-Writer XML-Writer-String
23 Using the perfSONAR 20 Bundle Installer
After you have downloaded and unzipped the perfSONAR 20 bundle you can start the installer by
9 Execute the bundle installer using the command perl installpl
a Make sure you are in the perfsonar-bundle directory (for example homeperfsonarperfsonar-20-bundle)
b If perl is not on your PATH you will have to give the complete path to the perl binary - PERL_PATHperl installpl
The installer starts
Note You can exit the installer at any time using the Exit command form the main menu or typing CTRL+C
10 The installer beginning screen displays three options
1 Install a new service Choose this option if you want to install a new service You can also use this option if you have already installed an instance of the same service (for example RRD MA) but would like to install another instance on the same machine
2 Modify or test an existing installation Choose this option to modify configuration details or test existing installations of perfSONAR services This option will not work if you have not already installed any of the services using the perfSONAR 20 bundle
3 Give feedback to the perfSONAR team Your feedback will be sent to us by the installer
If yoursquore installing a new service (and therefore select Option 1)
bull If you chose the first option the bundle installer provides a list of six services that can be installed Simply choose the service that you would like to install from this list
bull The bundle installer automatically downloads installation files for each service and executes the installation steps in sequence for the chosen service
bull Before downloading the installer files for a service the bundle installer will search to see if it can find existing downloads of installation files If you want to install two instances of the same service on the same workstation you can re-use the already downloaded installation files This will not affect the first instance
perfSONAR 21 8
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull If the bundle installer cannot find installation files it will give you the option to either ask it to download the files and install or you can specify an alternate path where the files have been downloaded previously
bull If files have to be downloaded the installer will automatically download and extract the required files It will ask you if you want it to extract to location different from the default one We suggest that you choose the default location
bull After downloading the required files (or accepting an existing installation files directory) the bundle installer will ask you if you want to do a basic installation or an advanced one Choose the basic installation unless you are feeling adventurous See ldquo25 Advanced Installationrdquo on page 38 The steps below are for basic installation
bull Depending on the service chosen you will be asked several questions If you make a mistake at any time quit (CTRL+C) and you can start again (bundle installer will ask you) If you experience some problems or have some questions try out the support pages (FAQs) or contact the mailing list
24 Interactive Questions
The perfSONAR installer prompts you for the information required to install the bundled software
Below are the prompts and questions you need to answer subdivided by service
Note Please review these questions and have all the required information ready to hand before installing the software Explanations for each question are given below and appropriate defaults are included whenever possible
241 RRD Measurement Archive (Java)
2411 Pre-installation
Enter the name of the service [perfSONAR-RRD-MA-20]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-RRD-MA-20
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
perfSONAR 21 9
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [1]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation This is the port number that will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you need another port number then you must also setup Tomcat to use this
new number To do this open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Do you want me to compile rrdjtool library for you (if not you will have to do it manually in
rootperfSONAR-RRD-MA-20perfsonarcontribrrdjtool after pre-install step) (yn)
bull Explanation The service needs the library of rrdjtool which is an interface to RRD files The script can build the library for you if the answer is y
bull Default none
IF answer is y Enter operating system type (linuxlinux-64bitfreebsdsolarisother)
perfSONAR 21 10
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information what OS do you have on your machine You can find a list of accepted operating systems in round brackets
bull Default none
IF answer is y Enter the directory path where header file of the rrdtool (rrdh) can be found [usrlocalrrdtoolinclude]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where the header file of rrdtool is located
bull Default usrlocalrrdtoolinclude bull Recommendation The path in square brackets in only an example
IF answer is y Enter the directory path where library files of the rrdtool (librrd) can be found [usrlocalrrdtoollib]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where library files of rrdtool are located
bull Default usrlocalrrdtoollib bull Recommendation The path in square brackets in only an example
IF answer is y Enter the home directory where the Java is installed (I need the home directory and not the directory where
the executable binary is present) [usrlocaljdk150]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where Java installation is located (rrdjtool is a java library so Java is required for building)
bull Default usrlocaljdk150 bull Recommendation The path in square brackets in only an example
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
perfSONAR 21 11
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter a URL of eXist web application package (exist-101war) [2]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example rrdmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank)
perfSONAR 21 12
perfSONAR 20 Administration Guide Installing perfSONAR 20
everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2412 Configuration
Enter the path of rrd metadata configuration file [rootperfSONAR-RRD-MA-20perfsonarconfrrd-database_TESTxml]
bull Explanation The script asks for the metadata configuration file This file contains the description of measurement data in RRD files If you wanted to use the xml database in the pre-install step then the metadata configuration file will be stored there later on during the Deployment
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in RRD files
bull Default none
Enter location of new RRD files created when measurement data is sent to the service [rootwebapps]
bull Explanation The service can receive messages with measurement data and store them in RRD files Here the script asks for the location where the service will create new RRD files
bull Default ltcurrent_directorygtwebapps
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
2413 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
perfSONAR 21 13
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-RRD-MA-20
[echo] docBase=rootwebappsperfSONAR-RRD-MA-20gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that Tomcat is running
[echo] You can do it using your web browser and connect the address http1270018080
[echo] or looking at Tomcats log file (rootapache-tomcat-607logscatalinaout)
Press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
Do you want me to add new user (provided in the pre-install step) and initiate the xml database eXist (If your eXist
is already configured and initialized for RRD MA answer n But probably its your first run of this installation script
so you have not added this user and initialized the database yet) (yn)
bull Explanation In case of use of the xml database eXist it needs to be set up (this means it must have an account and the metadata configuration specified in the pre-install and configure steps of the installation procedure)
bull Default none bull Recommendation If the xml database already has been set up the answer should be n
perfSONAR 21 14
perfSONAR 20 Administration Guide Installing perfSONAR 20
242 SQL Measurement Archive
2421 Pre-install step
Enter the name of the service [perfSONAR-SQL-MA-10]
bull Explanation - The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-SQL-MA-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [3]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
perfSONAR 21 15
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
IF answer is y Enter a URL of eXist web application package (exist-101war) [4]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
perfSONAR 21 16
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example sqlmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank) everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2422 Configuration
[echo] This service requires access to the relational database
[echo] (mySQL or postgeSQL but others can be used as well)
[echo] Make sure that you have one or install it from scratch
Please do it now and press Enter when finished
bull Explanation The script wants to know if a relational database is installed on the system If you already have one installed just press Enter If not please install one at this point and then press Enter so that the script can continue the installation of the service
bull Default none
[echo] In order to maintain data of utilization metric andor L2 path status metric
[echo] please prepare your relational database
[echo] In case of mySQL use simple script file mysql-sqlma-dbsetupsql
[echo] that you can find in conf directory (rootperfSONAR-SQL-MA-10perfsonarconf)
[echo] of perfSONAR SQL MA installation package
perfSONAR 21 17
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
Note For RRD MA it is important that you set the LD_LIBRARY_PATH variable ideally in the profile where the service is installed This will make sure that whenever you restart tomcat or reboot the machine the variable is applied before tomcat is restarted If this is not done the service will not be able to read the configured RRD Files
21 Points To Consider
bull With perfSONAR 20 you can install any number of services on the same tomcat instance Apart from installations of different service types these installations could also include new instances of the same service type (you can install two SQL MA services on the same tomcat along with any other service type)
bull To make use of this feature be aware that If the service requires XML database (RRD MA SQL MA and LS) please make sure that you
configure each service to use a different username and password Do not use eXist XML Database USERNAMES AND COLLECTIONS across two installations
You must have a different document base for each service To do this choose a different service name than the one already in use (ex XML-LS-11 and XML-LS2-11 if they are on the same tomcat)
bull Only Java services can be installed in tomcat
22 perfSONAR 20 Prerequisites
The perfSONAR bundle contains six services (Web Services Applications) The prerequisites for installing each of these services are different Some of these requirements have to be manually installed while others can by automatically installed during the perfSONAR installation process However you can manually install all the requirements (including the automatic ones) if required
221 Manual Installation of pre-requisites
Depending on the applicationservice you wish to deploy you may be required to manually install some required software
The lists below define general prerequisites for all services followed by specific prerequisites for the individual service
Note Time durations given as rough estimates only and are given only as an indication of the effort involved They do not include stitching or installing operating systems
perfSONAR 21 4
perfSONAR 20 Administration Guide Installing perfSONAR 20
2211 General Requirements
Required for all services
bull Operating System Redhat LinuxFedora Other versions of unix are supported for most services but not all See the requirements for the
service that you want to install Installations on Windows not supported (some services RRD MA for example will not work) wget command should be available on the OS This is required by the installer to download
dependency software
bull Perl - version 561 or higher The Perl Module LWP
2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
bull JAVA (JDK 5 version 15) bull Apache Ant (Version 16x) bull RRDTool to read your RRD files (version 12x)
Make sure you have the following files related to RRDTool on your workstation mdash rrdh - Usually found in $RRDTOOL_HOMEinclude directory mdash Approximately 10 files starting with the name librrd They are usually found in
$RRDTOOL_HOMElib directory
Note During the installation and deployment process you will be required to setup LD_LIBRARY_PATH environment variable It is extremely important that this environment variable is set before every restart of Tomcat We suggest that the LD_LIBRARY_PATH environment variable declaration be added to the profile information of the account where this service is installed The installation process will suggest the value to be used for this variable
2213 SQL Measurement Archive - (Effort ~2 hr)
bull JAVA (JDK 5 - version 15) bull Apache Ant (version 16x) bull MySQL or PostgreSQL Relational Database
Mysql (version 50) PostgreSQL (version 8x)
perfSONAR 21 5
perfSONAR 20 Administration Guide Installing perfSONAR 20
2214 Lookup Service - (Effort ~15 hr)
bull JAVA (JDK 5 - version 15 or later) bull Apache Ant (16x) bull eXist XML Database (version 101 or 111)
Note You can re-use an already installed eXist XML database However if you are installing a new database we recommend installing it in tomcat as a webapp (download war file) Some configuration may be required after installation (see httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS for a short tutorial)
2215 SSHTelnet Measurement Point - (Effort ~20 hr)
bull JAVA (JDK 5 - version 15 or later - available here) bull Apache Ant - version 16x - available here bull You will also need to know the list of routersdevices and the commands on the routers that you
wish to make available via this tool
2216 Command Line Measurement Point - (Effort ~20 hr)
bull JAVA (JDK 5 - version 15 or later) bull Apache Ant (version 16x) bull OWAMP tool (version xx) bull BWCTL tool (version xx) bull Ping tool bull Traceroute tool
2217 BWCTL Measurement Point (Perl)
bull Operating System - Redhat LinuxFedora bull BWCTL MP not testedwont work on other flavors of unix OS bull Perl - version 561 or higher bull BWCTL tool (version 11b or later) bull Iperf tool (version 202 or later) bull Perl Modules that are required to be installed manually
None (unless automatic installations of the required modules fail)
222 Automatic Installation of pre-requisites
The following requirements can be installed automatically
perfSONAR 21 6
perfSONAR 20 Administration Guide Installing perfSONAR 20
Note Even if two services have common requirements it is not necessary to install the same software twice on the same workstation However you may want to record the directory where the software has been automatically installed
2221 RRD Measurement Archive (Java)
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later - available here) bull RRDJtool (as JNI)
2222 SQL Measurement Archive
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2223 Lookup Service
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2224 SSHTelnet Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2225 Command Line Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2226 BWCTL Measurement Point
bull Perl Modules that will be installed automatically Bit-Vector Carp-Clan Compress-Zlib Date-Calc Date-Manip HTML-Parser HTML-Tagset IO-Tty IPC-Run libwww-perl Log-Dispatch
perfSONAR 21 7
perfSONAR 20 Administration Guide Installing perfSONAR 20
Module-Build Params-Validate SOAP-Lite (version 066) URI XML-LibXML XML-LibXML-Common XML-NamespaceSupport XML-SAX XML-Writer XML-Writer-String
23 Using the perfSONAR 20 Bundle Installer
After you have downloaded and unzipped the perfSONAR 20 bundle you can start the installer by
9 Execute the bundle installer using the command perl installpl
a Make sure you are in the perfsonar-bundle directory (for example homeperfsonarperfsonar-20-bundle)
b If perl is not on your PATH you will have to give the complete path to the perl binary - PERL_PATHperl installpl
The installer starts
Note You can exit the installer at any time using the Exit command form the main menu or typing CTRL+C
10 The installer beginning screen displays three options
1 Install a new service Choose this option if you want to install a new service You can also use this option if you have already installed an instance of the same service (for example RRD MA) but would like to install another instance on the same machine
2 Modify or test an existing installation Choose this option to modify configuration details or test existing installations of perfSONAR services This option will not work if you have not already installed any of the services using the perfSONAR 20 bundle
3 Give feedback to the perfSONAR team Your feedback will be sent to us by the installer
If yoursquore installing a new service (and therefore select Option 1)
bull If you chose the first option the bundle installer provides a list of six services that can be installed Simply choose the service that you would like to install from this list
bull The bundle installer automatically downloads installation files for each service and executes the installation steps in sequence for the chosen service
bull Before downloading the installer files for a service the bundle installer will search to see if it can find existing downloads of installation files If you want to install two instances of the same service on the same workstation you can re-use the already downloaded installation files This will not affect the first instance
perfSONAR 21 8
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull If the bundle installer cannot find installation files it will give you the option to either ask it to download the files and install or you can specify an alternate path where the files have been downloaded previously
bull If files have to be downloaded the installer will automatically download and extract the required files It will ask you if you want it to extract to location different from the default one We suggest that you choose the default location
bull After downloading the required files (or accepting an existing installation files directory) the bundle installer will ask you if you want to do a basic installation or an advanced one Choose the basic installation unless you are feeling adventurous See ldquo25 Advanced Installationrdquo on page 38 The steps below are for basic installation
bull Depending on the service chosen you will be asked several questions If you make a mistake at any time quit (CTRL+C) and you can start again (bundle installer will ask you) If you experience some problems or have some questions try out the support pages (FAQs) or contact the mailing list
24 Interactive Questions
The perfSONAR installer prompts you for the information required to install the bundled software
Below are the prompts and questions you need to answer subdivided by service
Note Please review these questions and have all the required information ready to hand before installing the software Explanations for each question are given below and appropriate defaults are included whenever possible
241 RRD Measurement Archive (Java)
2411 Pre-installation
Enter the name of the service [perfSONAR-RRD-MA-20]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-RRD-MA-20
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
perfSONAR 21 9
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [1]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation This is the port number that will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you need another port number then you must also setup Tomcat to use this
new number To do this open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Do you want me to compile rrdjtool library for you (if not you will have to do it manually in
rootperfSONAR-RRD-MA-20perfsonarcontribrrdjtool after pre-install step) (yn)
bull Explanation The service needs the library of rrdjtool which is an interface to RRD files The script can build the library for you if the answer is y
bull Default none
IF answer is y Enter operating system type (linuxlinux-64bitfreebsdsolarisother)
perfSONAR 21 10
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information what OS do you have on your machine You can find a list of accepted operating systems in round brackets
bull Default none
IF answer is y Enter the directory path where header file of the rrdtool (rrdh) can be found [usrlocalrrdtoolinclude]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where the header file of rrdtool is located
bull Default usrlocalrrdtoolinclude bull Recommendation The path in square brackets in only an example
IF answer is y Enter the directory path where library files of the rrdtool (librrd) can be found [usrlocalrrdtoollib]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where library files of rrdtool are located
bull Default usrlocalrrdtoollib bull Recommendation The path in square brackets in only an example
IF answer is y Enter the home directory where the Java is installed (I need the home directory and not the directory where
the executable binary is present) [usrlocaljdk150]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where Java installation is located (rrdjtool is a java library so Java is required for building)
bull Default usrlocaljdk150 bull Recommendation The path in square brackets in only an example
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
perfSONAR 21 11
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter a URL of eXist web application package (exist-101war) [2]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example rrdmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank)
perfSONAR 21 12
perfSONAR 20 Administration Guide Installing perfSONAR 20
everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2412 Configuration
Enter the path of rrd metadata configuration file [rootperfSONAR-RRD-MA-20perfsonarconfrrd-database_TESTxml]
bull Explanation The script asks for the metadata configuration file This file contains the description of measurement data in RRD files If you wanted to use the xml database in the pre-install step then the metadata configuration file will be stored there later on during the Deployment
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in RRD files
bull Default none
Enter location of new RRD files created when measurement data is sent to the service [rootwebapps]
bull Explanation The service can receive messages with measurement data and store them in RRD files Here the script asks for the location where the service will create new RRD files
bull Default ltcurrent_directorygtwebapps
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
2413 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
perfSONAR 21 13
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-RRD-MA-20
[echo] docBase=rootwebappsperfSONAR-RRD-MA-20gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that Tomcat is running
[echo] You can do it using your web browser and connect the address http1270018080
[echo] or looking at Tomcats log file (rootapache-tomcat-607logscatalinaout)
Press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
Do you want me to add new user (provided in the pre-install step) and initiate the xml database eXist (If your eXist
is already configured and initialized for RRD MA answer n But probably its your first run of this installation script
so you have not added this user and initialized the database yet) (yn)
bull Explanation In case of use of the xml database eXist it needs to be set up (this means it must have an account and the metadata configuration specified in the pre-install and configure steps of the installation procedure)
bull Default none bull Recommendation If the xml database already has been set up the answer should be n
perfSONAR 21 14
perfSONAR 20 Administration Guide Installing perfSONAR 20
242 SQL Measurement Archive
2421 Pre-install step
Enter the name of the service [perfSONAR-SQL-MA-10]
bull Explanation - The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-SQL-MA-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [3]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
perfSONAR 21 15
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
IF answer is y Enter a URL of eXist web application package (exist-101war) [4]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
perfSONAR 21 16
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example sqlmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank) everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2422 Configuration
[echo] This service requires access to the relational database
[echo] (mySQL or postgeSQL but others can be used as well)
[echo] Make sure that you have one or install it from scratch
Please do it now and press Enter when finished
bull Explanation The script wants to know if a relational database is installed on the system If you already have one installed just press Enter If not please install one at this point and then press Enter so that the script can continue the installation of the service
bull Default none
[echo] In order to maintain data of utilization metric andor L2 path status metric
[echo] please prepare your relational database
[echo] In case of mySQL use simple script file mysql-sqlma-dbsetupsql
[echo] that you can find in conf directory (rootperfSONAR-SQL-MA-10perfsonarconf)
[echo] of perfSONAR SQL MA installation package
perfSONAR 21 17
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
2211 General Requirements
Required for all services
bull Operating System Redhat LinuxFedora Other versions of unix are supported for most services but not all See the requirements for the
service that you want to install Installations on Windows not supported (some services RRD MA for example will not work) wget command should be available on the OS This is required by the installer to download
dependency software
bull Perl - version 561 or higher The Perl Module LWP
2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
bull JAVA (JDK 5 version 15) bull Apache Ant (Version 16x) bull RRDTool to read your RRD files (version 12x)
Make sure you have the following files related to RRDTool on your workstation mdash rrdh - Usually found in $RRDTOOL_HOMEinclude directory mdash Approximately 10 files starting with the name librrd They are usually found in
$RRDTOOL_HOMElib directory
Note During the installation and deployment process you will be required to setup LD_LIBRARY_PATH environment variable It is extremely important that this environment variable is set before every restart of Tomcat We suggest that the LD_LIBRARY_PATH environment variable declaration be added to the profile information of the account where this service is installed The installation process will suggest the value to be used for this variable
2213 SQL Measurement Archive - (Effort ~2 hr)
bull JAVA (JDK 5 - version 15) bull Apache Ant (version 16x) bull MySQL or PostgreSQL Relational Database
Mysql (version 50) PostgreSQL (version 8x)
perfSONAR 21 5
perfSONAR 20 Administration Guide Installing perfSONAR 20
2214 Lookup Service - (Effort ~15 hr)
bull JAVA (JDK 5 - version 15 or later) bull Apache Ant (16x) bull eXist XML Database (version 101 or 111)
Note You can re-use an already installed eXist XML database However if you are installing a new database we recommend installing it in tomcat as a webapp (download war file) Some configuration may be required after installation (see httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS for a short tutorial)
2215 SSHTelnet Measurement Point - (Effort ~20 hr)
bull JAVA (JDK 5 - version 15 or later - available here) bull Apache Ant - version 16x - available here bull You will also need to know the list of routersdevices and the commands on the routers that you
wish to make available via this tool
2216 Command Line Measurement Point - (Effort ~20 hr)
bull JAVA (JDK 5 - version 15 or later) bull Apache Ant (version 16x) bull OWAMP tool (version xx) bull BWCTL tool (version xx) bull Ping tool bull Traceroute tool
2217 BWCTL Measurement Point (Perl)
bull Operating System - Redhat LinuxFedora bull BWCTL MP not testedwont work on other flavors of unix OS bull Perl - version 561 or higher bull BWCTL tool (version 11b or later) bull Iperf tool (version 202 or later) bull Perl Modules that are required to be installed manually
None (unless automatic installations of the required modules fail)
222 Automatic Installation of pre-requisites
The following requirements can be installed automatically
perfSONAR 21 6
perfSONAR 20 Administration Guide Installing perfSONAR 20
Note Even if two services have common requirements it is not necessary to install the same software twice on the same workstation However you may want to record the directory where the software has been automatically installed
2221 RRD Measurement Archive (Java)
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later - available here) bull RRDJtool (as JNI)
2222 SQL Measurement Archive
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2223 Lookup Service
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2224 SSHTelnet Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2225 Command Line Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2226 BWCTL Measurement Point
bull Perl Modules that will be installed automatically Bit-Vector Carp-Clan Compress-Zlib Date-Calc Date-Manip HTML-Parser HTML-Tagset IO-Tty IPC-Run libwww-perl Log-Dispatch
perfSONAR 21 7
perfSONAR 20 Administration Guide Installing perfSONAR 20
Module-Build Params-Validate SOAP-Lite (version 066) URI XML-LibXML XML-LibXML-Common XML-NamespaceSupport XML-SAX XML-Writer XML-Writer-String
23 Using the perfSONAR 20 Bundle Installer
After you have downloaded and unzipped the perfSONAR 20 bundle you can start the installer by
9 Execute the bundle installer using the command perl installpl
a Make sure you are in the perfsonar-bundle directory (for example homeperfsonarperfsonar-20-bundle)
b If perl is not on your PATH you will have to give the complete path to the perl binary - PERL_PATHperl installpl
The installer starts
Note You can exit the installer at any time using the Exit command form the main menu or typing CTRL+C
10 The installer beginning screen displays three options
1 Install a new service Choose this option if you want to install a new service You can also use this option if you have already installed an instance of the same service (for example RRD MA) but would like to install another instance on the same machine
2 Modify or test an existing installation Choose this option to modify configuration details or test existing installations of perfSONAR services This option will not work if you have not already installed any of the services using the perfSONAR 20 bundle
3 Give feedback to the perfSONAR team Your feedback will be sent to us by the installer
If yoursquore installing a new service (and therefore select Option 1)
bull If you chose the first option the bundle installer provides a list of six services that can be installed Simply choose the service that you would like to install from this list
bull The bundle installer automatically downloads installation files for each service and executes the installation steps in sequence for the chosen service
bull Before downloading the installer files for a service the bundle installer will search to see if it can find existing downloads of installation files If you want to install two instances of the same service on the same workstation you can re-use the already downloaded installation files This will not affect the first instance
perfSONAR 21 8
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull If the bundle installer cannot find installation files it will give you the option to either ask it to download the files and install or you can specify an alternate path where the files have been downloaded previously
bull If files have to be downloaded the installer will automatically download and extract the required files It will ask you if you want it to extract to location different from the default one We suggest that you choose the default location
bull After downloading the required files (or accepting an existing installation files directory) the bundle installer will ask you if you want to do a basic installation or an advanced one Choose the basic installation unless you are feeling adventurous See ldquo25 Advanced Installationrdquo on page 38 The steps below are for basic installation
bull Depending on the service chosen you will be asked several questions If you make a mistake at any time quit (CTRL+C) and you can start again (bundle installer will ask you) If you experience some problems or have some questions try out the support pages (FAQs) or contact the mailing list
24 Interactive Questions
The perfSONAR installer prompts you for the information required to install the bundled software
Below are the prompts and questions you need to answer subdivided by service
Note Please review these questions and have all the required information ready to hand before installing the software Explanations for each question are given below and appropriate defaults are included whenever possible
241 RRD Measurement Archive (Java)
2411 Pre-installation
Enter the name of the service [perfSONAR-RRD-MA-20]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-RRD-MA-20
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
perfSONAR 21 9
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [1]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation This is the port number that will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you need another port number then you must also setup Tomcat to use this
new number To do this open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Do you want me to compile rrdjtool library for you (if not you will have to do it manually in
rootperfSONAR-RRD-MA-20perfsonarcontribrrdjtool after pre-install step) (yn)
bull Explanation The service needs the library of rrdjtool which is an interface to RRD files The script can build the library for you if the answer is y
bull Default none
IF answer is y Enter operating system type (linuxlinux-64bitfreebsdsolarisother)
perfSONAR 21 10
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information what OS do you have on your machine You can find a list of accepted operating systems in round brackets
bull Default none
IF answer is y Enter the directory path where header file of the rrdtool (rrdh) can be found [usrlocalrrdtoolinclude]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where the header file of rrdtool is located
bull Default usrlocalrrdtoolinclude bull Recommendation The path in square brackets in only an example
IF answer is y Enter the directory path where library files of the rrdtool (librrd) can be found [usrlocalrrdtoollib]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where library files of rrdtool are located
bull Default usrlocalrrdtoollib bull Recommendation The path in square brackets in only an example
IF answer is y Enter the home directory where the Java is installed (I need the home directory and not the directory where
the executable binary is present) [usrlocaljdk150]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where Java installation is located (rrdjtool is a java library so Java is required for building)
bull Default usrlocaljdk150 bull Recommendation The path in square brackets in only an example
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
perfSONAR 21 11
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter a URL of eXist web application package (exist-101war) [2]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example rrdmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank)
perfSONAR 21 12
perfSONAR 20 Administration Guide Installing perfSONAR 20
everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2412 Configuration
Enter the path of rrd metadata configuration file [rootperfSONAR-RRD-MA-20perfsonarconfrrd-database_TESTxml]
bull Explanation The script asks for the metadata configuration file This file contains the description of measurement data in RRD files If you wanted to use the xml database in the pre-install step then the metadata configuration file will be stored there later on during the Deployment
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in RRD files
bull Default none
Enter location of new RRD files created when measurement data is sent to the service [rootwebapps]
bull Explanation The service can receive messages with measurement data and store them in RRD files Here the script asks for the location where the service will create new RRD files
bull Default ltcurrent_directorygtwebapps
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
2413 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
perfSONAR 21 13
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-RRD-MA-20
[echo] docBase=rootwebappsperfSONAR-RRD-MA-20gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that Tomcat is running
[echo] You can do it using your web browser and connect the address http1270018080
[echo] or looking at Tomcats log file (rootapache-tomcat-607logscatalinaout)
Press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
Do you want me to add new user (provided in the pre-install step) and initiate the xml database eXist (If your eXist
is already configured and initialized for RRD MA answer n But probably its your first run of this installation script
so you have not added this user and initialized the database yet) (yn)
bull Explanation In case of use of the xml database eXist it needs to be set up (this means it must have an account and the metadata configuration specified in the pre-install and configure steps of the installation procedure)
bull Default none bull Recommendation If the xml database already has been set up the answer should be n
perfSONAR 21 14
perfSONAR 20 Administration Guide Installing perfSONAR 20
242 SQL Measurement Archive
2421 Pre-install step
Enter the name of the service [perfSONAR-SQL-MA-10]
bull Explanation - The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-SQL-MA-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [3]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
perfSONAR 21 15
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
IF answer is y Enter a URL of eXist web application package (exist-101war) [4]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
perfSONAR 21 16
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example sqlmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank) everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2422 Configuration
[echo] This service requires access to the relational database
[echo] (mySQL or postgeSQL but others can be used as well)
[echo] Make sure that you have one or install it from scratch
Please do it now and press Enter when finished
bull Explanation The script wants to know if a relational database is installed on the system If you already have one installed just press Enter If not please install one at this point and then press Enter so that the script can continue the installation of the service
bull Default none
[echo] In order to maintain data of utilization metric andor L2 path status metric
[echo] please prepare your relational database
[echo] In case of mySQL use simple script file mysql-sqlma-dbsetupsql
[echo] that you can find in conf directory (rootperfSONAR-SQL-MA-10perfsonarconf)
[echo] of perfSONAR SQL MA installation package
perfSONAR 21 17
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
2214 Lookup Service - (Effort ~15 hr)
bull JAVA (JDK 5 - version 15 or later) bull Apache Ant (16x) bull eXist XML Database (version 101 or 111)
Note You can re-use an already installed eXist XML database However if you are installing a new database we recommend installing it in tomcat as a webapp (download war file) Some configuration may be required after installation (see httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS for a short tutorial)
2215 SSHTelnet Measurement Point - (Effort ~20 hr)
bull JAVA (JDK 5 - version 15 or later - available here) bull Apache Ant - version 16x - available here bull You will also need to know the list of routersdevices and the commands on the routers that you
wish to make available via this tool
2216 Command Line Measurement Point - (Effort ~20 hr)
bull JAVA (JDK 5 - version 15 or later) bull Apache Ant (version 16x) bull OWAMP tool (version xx) bull BWCTL tool (version xx) bull Ping tool bull Traceroute tool
2217 BWCTL Measurement Point (Perl)
bull Operating System - Redhat LinuxFedora bull BWCTL MP not testedwont work on other flavors of unix OS bull Perl - version 561 or higher bull BWCTL tool (version 11b or later) bull Iperf tool (version 202 or later) bull Perl Modules that are required to be installed manually
None (unless automatic installations of the required modules fail)
222 Automatic Installation of pre-requisites
The following requirements can be installed automatically
perfSONAR 21 6
perfSONAR 20 Administration Guide Installing perfSONAR 20
Note Even if two services have common requirements it is not necessary to install the same software twice on the same workstation However you may want to record the directory where the software has been automatically installed
2221 RRD Measurement Archive (Java)
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later - available here) bull RRDJtool (as JNI)
2222 SQL Measurement Archive
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2223 Lookup Service
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2224 SSHTelnet Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2225 Command Line Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2226 BWCTL Measurement Point
bull Perl Modules that will be installed automatically Bit-Vector Carp-Clan Compress-Zlib Date-Calc Date-Manip HTML-Parser HTML-Tagset IO-Tty IPC-Run libwww-perl Log-Dispatch
perfSONAR 21 7
perfSONAR 20 Administration Guide Installing perfSONAR 20
Module-Build Params-Validate SOAP-Lite (version 066) URI XML-LibXML XML-LibXML-Common XML-NamespaceSupport XML-SAX XML-Writer XML-Writer-String
23 Using the perfSONAR 20 Bundle Installer
After you have downloaded and unzipped the perfSONAR 20 bundle you can start the installer by
9 Execute the bundle installer using the command perl installpl
a Make sure you are in the perfsonar-bundle directory (for example homeperfsonarperfsonar-20-bundle)
b If perl is not on your PATH you will have to give the complete path to the perl binary - PERL_PATHperl installpl
The installer starts
Note You can exit the installer at any time using the Exit command form the main menu or typing CTRL+C
10 The installer beginning screen displays three options
1 Install a new service Choose this option if you want to install a new service You can also use this option if you have already installed an instance of the same service (for example RRD MA) but would like to install another instance on the same machine
2 Modify or test an existing installation Choose this option to modify configuration details or test existing installations of perfSONAR services This option will not work if you have not already installed any of the services using the perfSONAR 20 bundle
3 Give feedback to the perfSONAR team Your feedback will be sent to us by the installer
If yoursquore installing a new service (and therefore select Option 1)
bull If you chose the first option the bundle installer provides a list of six services that can be installed Simply choose the service that you would like to install from this list
bull The bundle installer automatically downloads installation files for each service and executes the installation steps in sequence for the chosen service
bull Before downloading the installer files for a service the bundle installer will search to see if it can find existing downloads of installation files If you want to install two instances of the same service on the same workstation you can re-use the already downloaded installation files This will not affect the first instance
perfSONAR 21 8
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull If the bundle installer cannot find installation files it will give you the option to either ask it to download the files and install or you can specify an alternate path where the files have been downloaded previously
bull If files have to be downloaded the installer will automatically download and extract the required files It will ask you if you want it to extract to location different from the default one We suggest that you choose the default location
bull After downloading the required files (or accepting an existing installation files directory) the bundle installer will ask you if you want to do a basic installation or an advanced one Choose the basic installation unless you are feeling adventurous See ldquo25 Advanced Installationrdquo on page 38 The steps below are for basic installation
bull Depending on the service chosen you will be asked several questions If you make a mistake at any time quit (CTRL+C) and you can start again (bundle installer will ask you) If you experience some problems or have some questions try out the support pages (FAQs) or contact the mailing list
24 Interactive Questions
The perfSONAR installer prompts you for the information required to install the bundled software
Below are the prompts and questions you need to answer subdivided by service
Note Please review these questions and have all the required information ready to hand before installing the software Explanations for each question are given below and appropriate defaults are included whenever possible
241 RRD Measurement Archive (Java)
2411 Pre-installation
Enter the name of the service [perfSONAR-RRD-MA-20]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-RRD-MA-20
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
perfSONAR 21 9
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [1]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation This is the port number that will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you need another port number then you must also setup Tomcat to use this
new number To do this open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Do you want me to compile rrdjtool library for you (if not you will have to do it manually in
rootperfSONAR-RRD-MA-20perfsonarcontribrrdjtool after pre-install step) (yn)
bull Explanation The service needs the library of rrdjtool which is an interface to RRD files The script can build the library for you if the answer is y
bull Default none
IF answer is y Enter operating system type (linuxlinux-64bitfreebsdsolarisother)
perfSONAR 21 10
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information what OS do you have on your machine You can find a list of accepted operating systems in round brackets
bull Default none
IF answer is y Enter the directory path where header file of the rrdtool (rrdh) can be found [usrlocalrrdtoolinclude]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where the header file of rrdtool is located
bull Default usrlocalrrdtoolinclude bull Recommendation The path in square brackets in only an example
IF answer is y Enter the directory path where library files of the rrdtool (librrd) can be found [usrlocalrrdtoollib]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where library files of rrdtool are located
bull Default usrlocalrrdtoollib bull Recommendation The path in square brackets in only an example
IF answer is y Enter the home directory where the Java is installed (I need the home directory and not the directory where
the executable binary is present) [usrlocaljdk150]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where Java installation is located (rrdjtool is a java library so Java is required for building)
bull Default usrlocaljdk150 bull Recommendation The path in square brackets in only an example
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
perfSONAR 21 11
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter a URL of eXist web application package (exist-101war) [2]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example rrdmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank)
perfSONAR 21 12
perfSONAR 20 Administration Guide Installing perfSONAR 20
everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2412 Configuration
Enter the path of rrd metadata configuration file [rootperfSONAR-RRD-MA-20perfsonarconfrrd-database_TESTxml]
bull Explanation The script asks for the metadata configuration file This file contains the description of measurement data in RRD files If you wanted to use the xml database in the pre-install step then the metadata configuration file will be stored there later on during the Deployment
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in RRD files
bull Default none
Enter location of new RRD files created when measurement data is sent to the service [rootwebapps]
bull Explanation The service can receive messages with measurement data and store them in RRD files Here the script asks for the location where the service will create new RRD files
bull Default ltcurrent_directorygtwebapps
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
2413 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
perfSONAR 21 13
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-RRD-MA-20
[echo] docBase=rootwebappsperfSONAR-RRD-MA-20gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that Tomcat is running
[echo] You can do it using your web browser and connect the address http1270018080
[echo] or looking at Tomcats log file (rootapache-tomcat-607logscatalinaout)
Press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
Do you want me to add new user (provided in the pre-install step) and initiate the xml database eXist (If your eXist
is already configured and initialized for RRD MA answer n But probably its your first run of this installation script
so you have not added this user and initialized the database yet) (yn)
bull Explanation In case of use of the xml database eXist it needs to be set up (this means it must have an account and the metadata configuration specified in the pre-install and configure steps of the installation procedure)
bull Default none bull Recommendation If the xml database already has been set up the answer should be n
perfSONAR 21 14
perfSONAR 20 Administration Guide Installing perfSONAR 20
242 SQL Measurement Archive
2421 Pre-install step
Enter the name of the service [perfSONAR-SQL-MA-10]
bull Explanation - The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-SQL-MA-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [3]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
perfSONAR 21 15
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
IF answer is y Enter a URL of eXist web application package (exist-101war) [4]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
perfSONAR 21 16
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example sqlmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank) everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2422 Configuration
[echo] This service requires access to the relational database
[echo] (mySQL or postgeSQL but others can be used as well)
[echo] Make sure that you have one or install it from scratch
Please do it now and press Enter when finished
bull Explanation The script wants to know if a relational database is installed on the system If you already have one installed just press Enter If not please install one at this point and then press Enter so that the script can continue the installation of the service
bull Default none
[echo] In order to maintain data of utilization metric andor L2 path status metric
[echo] please prepare your relational database
[echo] In case of mySQL use simple script file mysql-sqlma-dbsetupsql
[echo] that you can find in conf directory (rootperfSONAR-SQL-MA-10perfsonarconf)
[echo] of perfSONAR SQL MA installation package
perfSONAR 21 17
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
Note Even if two services have common requirements it is not necessary to install the same software twice on the same workstation However you may want to record the directory where the software has been automatically installed
2221 RRD Measurement Archive (Java)
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later - available here) bull RRDJtool (as JNI)
2222 SQL Measurement Archive
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2223 Lookup Service
bull Tomcat Application Server - Jakarta Tomcat bull eXist XML Database (Version 10 or later)
2224 SSHTelnet Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2225 Command Line Measurement Point
bull Tomcat Application Server - Jakarta Tomcat
2226 BWCTL Measurement Point
bull Perl Modules that will be installed automatically Bit-Vector Carp-Clan Compress-Zlib Date-Calc Date-Manip HTML-Parser HTML-Tagset IO-Tty IPC-Run libwww-perl Log-Dispatch
perfSONAR 21 7
perfSONAR 20 Administration Guide Installing perfSONAR 20
Module-Build Params-Validate SOAP-Lite (version 066) URI XML-LibXML XML-LibXML-Common XML-NamespaceSupport XML-SAX XML-Writer XML-Writer-String
23 Using the perfSONAR 20 Bundle Installer
After you have downloaded and unzipped the perfSONAR 20 bundle you can start the installer by
9 Execute the bundle installer using the command perl installpl
a Make sure you are in the perfsonar-bundle directory (for example homeperfsonarperfsonar-20-bundle)
b If perl is not on your PATH you will have to give the complete path to the perl binary - PERL_PATHperl installpl
The installer starts
Note You can exit the installer at any time using the Exit command form the main menu or typing CTRL+C
10 The installer beginning screen displays three options
1 Install a new service Choose this option if you want to install a new service You can also use this option if you have already installed an instance of the same service (for example RRD MA) but would like to install another instance on the same machine
2 Modify or test an existing installation Choose this option to modify configuration details or test existing installations of perfSONAR services This option will not work if you have not already installed any of the services using the perfSONAR 20 bundle
3 Give feedback to the perfSONAR team Your feedback will be sent to us by the installer
If yoursquore installing a new service (and therefore select Option 1)
bull If you chose the first option the bundle installer provides a list of six services that can be installed Simply choose the service that you would like to install from this list
bull The bundle installer automatically downloads installation files for each service and executes the installation steps in sequence for the chosen service
bull Before downloading the installer files for a service the bundle installer will search to see if it can find existing downloads of installation files If you want to install two instances of the same service on the same workstation you can re-use the already downloaded installation files This will not affect the first instance
perfSONAR 21 8
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull If the bundle installer cannot find installation files it will give you the option to either ask it to download the files and install or you can specify an alternate path where the files have been downloaded previously
bull If files have to be downloaded the installer will automatically download and extract the required files It will ask you if you want it to extract to location different from the default one We suggest that you choose the default location
bull After downloading the required files (or accepting an existing installation files directory) the bundle installer will ask you if you want to do a basic installation or an advanced one Choose the basic installation unless you are feeling adventurous See ldquo25 Advanced Installationrdquo on page 38 The steps below are for basic installation
bull Depending on the service chosen you will be asked several questions If you make a mistake at any time quit (CTRL+C) and you can start again (bundle installer will ask you) If you experience some problems or have some questions try out the support pages (FAQs) or contact the mailing list
24 Interactive Questions
The perfSONAR installer prompts you for the information required to install the bundled software
Below are the prompts and questions you need to answer subdivided by service
Note Please review these questions and have all the required information ready to hand before installing the software Explanations for each question are given below and appropriate defaults are included whenever possible
241 RRD Measurement Archive (Java)
2411 Pre-installation
Enter the name of the service [perfSONAR-RRD-MA-20]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-RRD-MA-20
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
perfSONAR 21 9
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [1]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation This is the port number that will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you need another port number then you must also setup Tomcat to use this
new number To do this open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Do you want me to compile rrdjtool library for you (if not you will have to do it manually in
rootperfSONAR-RRD-MA-20perfsonarcontribrrdjtool after pre-install step) (yn)
bull Explanation The service needs the library of rrdjtool which is an interface to RRD files The script can build the library for you if the answer is y
bull Default none
IF answer is y Enter operating system type (linuxlinux-64bitfreebsdsolarisother)
perfSONAR 21 10
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information what OS do you have on your machine You can find a list of accepted operating systems in round brackets
bull Default none
IF answer is y Enter the directory path where header file of the rrdtool (rrdh) can be found [usrlocalrrdtoolinclude]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where the header file of rrdtool is located
bull Default usrlocalrrdtoolinclude bull Recommendation The path in square brackets in only an example
IF answer is y Enter the directory path where library files of the rrdtool (librrd) can be found [usrlocalrrdtoollib]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where library files of rrdtool are located
bull Default usrlocalrrdtoollib bull Recommendation The path in square brackets in only an example
IF answer is y Enter the home directory where the Java is installed (I need the home directory and not the directory where
the executable binary is present) [usrlocaljdk150]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where Java installation is located (rrdjtool is a java library so Java is required for building)
bull Default usrlocaljdk150 bull Recommendation The path in square brackets in only an example
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
perfSONAR 21 11
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter a URL of eXist web application package (exist-101war) [2]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example rrdmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank)
perfSONAR 21 12
perfSONAR 20 Administration Guide Installing perfSONAR 20
everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2412 Configuration
Enter the path of rrd metadata configuration file [rootperfSONAR-RRD-MA-20perfsonarconfrrd-database_TESTxml]
bull Explanation The script asks for the metadata configuration file This file contains the description of measurement data in RRD files If you wanted to use the xml database in the pre-install step then the metadata configuration file will be stored there later on during the Deployment
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in RRD files
bull Default none
Enter location of new RRD files created when measurement data is sent to the service [rootwebapps]
bull Explanation The service can receive messages with measurement data and store them in RRD files Here the script asks for the location where the service will create new RRD files
bull Default ltcurrent_directorygtwebapps
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
2413 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
perfSONAR 21 13
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-RRD-MA-20
[echo] docBase=rootwebappsperfSONAR-RRD-MA-20gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that Tomcat is running
[echo] You can do it using your web browser and connect the address http1270018080
[echo] or looking at Tomcats log file (rootapache-tomcat-607logscatalinaout)
Press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
Do you want me to add new user (provided in the pre-install step) and initiate the xml database eXist (If your eXist
is already configured and initialized for RRD MA answer n But probably its your first run of this installation script
so you have not added this user and initialized the database yet) (yn)
bull Explanation In case of use of the xml database eXist it needs to be set up (this means it must have an account and the metadata configuration specified in the pre-install and configure steps of the installation procedure)
bull Default none bull Recommendation If the xml database already has been set up the answer should be n
perfSONAR 21 14
perfSONAR 20 Administration Guide Installing perfSONAR 20
242 SQL Measurement Archive
2421 Pre-install step
Enter the name of the service [perfSONAR-SQL-MA-10]
bull Explanation - The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-SQL-MA-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [3]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
perfSONAR 21 15
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
IF answer is y Enter a URL of eXist web application package (exist-101war) [4]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
perfSONAR 21 16
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example sqlmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank) everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2422 Configuration
[echo] This service requires access to the relational database
[echo] (mySQL or postgeSQL but others can be used as well)
[echo] Make sure that you have one or install it from scratch
Please do it now and press Enter when finished
bull Explanation The script wants to know if a relational database is installed on the system If you already have one installed just press Enter If not please install one at this point and then press Enter so that the script can continue the installation of the service
bull Default none
[echo] In order to maintain data of utilization metric andor L2 path status metric
[echo] please prepare your relational database
[echo] In case of mySQL use simple script file mysql-sqlma-dbsetupsql
[echo] that you can find in conf directory (rootperfSONAR-SQL-MA-10perfsonarconf)
[echo] of perfSONAR SQL MA installation package
perfSONAR 21 17
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
Module-Build Params-Validate SOAP-Lite (version 066) URI XML-LibXML XML-LibXML-Common XML-NamespaceSupport XML-SAX XML-Writer XML-Writer-String
23 Using the perfSONAR 20 Bundle Installer
After you have downloaded and unzipped the perfSONAR 20 bundle you can start the installer by
9 Execute the bundle installer using the command perl installpl
a Make sure you are in the perfsonar-bundle directory (for example homeperfsonarperfsonar-20-bundle)
b If perl is not on your PATH you will have to give the complete path to the perl binary - PERL_PATHperl installpl
The installer starts
Note You can exit the installer at any time using the Exit command form the main menu or typing CTRL+C
10 The installer beginning screen displays three options
1 Install a new service Choose this option if you want to install a new service You can also use this option if you have already installed an instance of the same service (for example RRD MA) but would like to install another instance on the same machine
2 Modify or test an existing installation Choose this option to modify configuration details or test existing installations of perfSONAR services This option will not work if you have not already installed any of the services using the perfSONAR 20 bundle
3 Give feedback to the perfSONAR team Your feedback will be sent to us by the installer
If yoursquore installing a new service (and therefore select Option 1)
bull If you chose the first option the bundle installer provides a list of six services that can be installed Simply choose the service that you would like to install from this list
bull The bundle installer automatically downloads installation files for each service and executes the installation steps in sequence for the chosen service
bull Before downloading the installer files for a service the bundle installer will search to see if it can find existing downloads of installation files If you want to install two instances of the same service on the same workstation you can re-use the already downloaded installation files This will not affect the first instance
perfSONAR 21 8
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull If the bundle installer cannot find installation files it will give you the option to either ask it to download the files and install or you can specify an alternate path where the files have been downloaded previously
bull If files have to be downloaded the installer will automatically download and extract the required files It will ask you if you want it to extract to location different from the default one We suggest that you choose the default location
bull After downloading the required files (or accepting an existing installation files directory) the bundle installer will ask you if you want to do a basic installation or an advanced one Choose the basic installation unless you are feeling adventurous See ldquo25 Advanced Installationrdquo on page 38 The steps below are for basic installation
bull Depending on the service chosen you will be asked several questions If you make a mistake at any time quit (CTRL+C) and you can start again (bundle installer will ask you) If you experience some problems or have some questions try out the support pages (FAQs) or contact the mailing list
24 Interactive Questions
The perfSONAR installer prompts you for the information required to install the bundled software
Below are the prompts and questions you need to answer subdivided by service
Note Please review these questions and have all the required information ready to hand before installing the software Explanations for each question are given below and appropriate defaults are included whenever possible
241 RRD Measurement Archive (Java)
2411 Pre-installation
Enter the name of the service [perfSONAR-RRD-MA-20]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-RRD-MA-20
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
perfSONAR 21 9
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [1]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation This is the port number that will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you need another port number then you must also setup Tomcat to use this
new number To do this open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Do you want me to compile rrdjtool library for you (if not you will have to do it manually in
rootperfSONAR-RRD-MA-20perfsonarcontribrrdjtool after pre-install step) (yn)
bull Explanation The service needs the library of rrdjtool which is an interface to RRD files The script can build the library for you if the answer is y
bull Default none
IF answer is y Enter operating system type (linuxlinux-64bitfreebsdsolarisother)
perfSONAR 21 10
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information what OS do you have on your machine You can find a list of accepted operating systems in round brackets
bull Default none
IF answer is y Enter the directory path where header file of the rrdtool (rrdh) can be found [usrlocalrrdtoolinclude]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where the header file of rrdtool is located
bull Default usrlocalrrdtoolinclude bull Recommendation The path in square brackets in only an example
IF answer is y Enter the directory path where library files of the rrdtool (librrd) can be found [usrlocalrrdtoollib]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where library files of rrdtool are located
bull Default usrlocalrrdtoollib bull Recommendation The path in square brackets in only an example
IF answer is y Enter the home directory where the Java is installed (I need the home directory and not the directory where
the executable binary is present) [usrlocaljdk150]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where Java installation is located (rrdjtool is a java library so Java is required for building)
bull Default usrlocaljdk150 bull Recommendation The path in square brackets in only an example
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
perfSONAR 21 11
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter a URL of eXist web application package (exist-101war) [2]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example rrdmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank)
perfSONAR 21 12
perfSONAR 20 Administration Guide Installing perfSONAR 20
everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2412 Configuration
Enter the path of rrd metadata configuration file [rootperfSONAR-RRD-MA-20perfsonarconfrrd-database_TESTxml]
bull Explanation The script asks for the metadata configuration file This file contains the description of measurement data in RRD files If you wanted to use the xml database in the pre-install step then the metadata configuration file will be stored there later on during the Deployment
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in RRD files
bull Default none
Enter location of new RRD files created when measurement data is sent to the service [rootwebapps]
bull Explanation The service can receive messages with measurement data and store them in RRD files Here the script asks for the location where the service will create new RRD files
bull Default ltcurrent_directorygtwebapps
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
2413 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
perfSONAR 21 13
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-RRD-MA-20
[echo] docBase=rootwebappsperfSONAR-RRD-MA-20gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that Tomcat is running
[echo] You can do it using your web browser and connect the address http1270018080
[echo] or looking at Tomcats log file (rootapache-tomcat-607logscatalinaout)
Press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
Do you want me to add new user (provided in the pre-install step) and initiate the xml database eXist (If your eXist
is already configured and initialized for RRD MA answer n But probably its your first run of this installation script
so you have not added this user and initialized the database yet) (yn)
bull Explanation In case of use of the xml database eXist it needs to be set up (this means it must have an account and the metadata configuration specified in the pre-install and configure steps of the installation procedure)
bull Default none bull Recommendation If the xml database already has been set up the answer should be n
perfSONAR 21 14
perfSONAR 20 Administration Guide Installing perfSONAR 20
242 SQL Measurement Archive
2421 Pre-install step
Enter the name of the service [perfSONAR-SQL-MA-10]
bull Explanation - The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-SQL-MA-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [3]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
perfSONAR 21 15
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
IF answer is y Enter a URL of eXist web application package (exist-101war) [4]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
perfSONAR 21 16
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example sqlmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank) everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2422 Configuration
[echo] This service requires access to the relational database
[echo] (mySQL or postgeSQL but others can be used as well)
[echo] Make sure that you have one or install it from scratch
Please do it now and press Enter when finished
bull Explanation The script wants to know if a relational database is installed on the system If you already have one installed just press Enter If not please install one at this point and then press Enter so that the script can continue the installation of the service
bull Default none
[echo] In order to maintain data of utilization metric andor L2 path status metric
[echo] please prepare your relational database
[echo] In case of mySQL use simple script file mysql-sqlma-dbsetupsql
[echo] that you can find in conf directory (rootperfSONAR-SQL-MA-10perfsonarconf)
[echo] of perfSONAR SQL MA installation package
perfSONAR 21 17
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull If the bundle installer cannot find installation files it will give you the option to either ask it to download the files and install or you can specify an alternate path where the files have been downloaded previously
bull If files have to be downloaded the installer will automatically download and extract the required files It will ask you if you want it to extract to location different from the default one We suggest that you choose the default location
bull After downloading the required files (or accepting an existing installation files directory) the bundle installer will ask you if you want to do a basic installation or an advanced one Choose the basic installation unless you are feeling adventurous See ldquo25 Advanced Installationrdquo on page 38 The steps below are for basic installation
bull Depending on the service chosen you will be asked several questions If you make a mistake at any time quit (CTRL+C) and you can start again (bundle installer will ask you) If you experience some problems or have some questions try out the support pages (FAQs) or contact the mailing list
24 Interactive Questions
The perfSONAR installer prompts you for the information required to install the bundled software
Below are the prompts and questions you need to answer subdivided by service
Note Please review these questions and have all the required information ready to hand before installing the software Explanations for each question are given below and appropriate defaults are included whenever possible
241 RRD Measurement Archive (Java)
2411 Pre-installation
Enter the name of the service [perfSONAR-RRD-MA-20]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-RRD-MA-20
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
perfSONAR 21 9
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [1]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation This is the port number that will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you need another port number then you must also setup Tomcat to use this
new number To do this open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Do you want me to compile rrdjtool library for you (if not you will have to do it manually in
rootperfSONAR-RRD-MA-20perfsonarcontribrrdjtool after pre-install step) (yn)
bull Explanation The service needs the library of rrdjtool which is an interface to RRD files The script can build the library for you if the answer is y
bull Default none
IF answer is y Enter operating system type (linuxlinux-64bitfreebsdsolarisother)
perfSONAR 21 10
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information what OS do you have on your machine You can find a list of accepted operating systems in round brackets
bull Default none
IF answer is y Enter the directory path where header file of the rrdtool (rrdh) can be found [usrlocalrrdtoolinclude]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where the header file of rrdtool is located
bull Default usrlocalrrdtoolinclude bull Recommendation The path in square brackets in only an example
IF answer is y Enter the directory path where library files of the rrdtool (librrd) can be found [usrlocalrrdtoollib]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where library files of rrdtool are located
bull Default usrlocalrrdtoollib bull Recommendation The path in square brackets in only an example
IF answer is y Enter the home directory where the Java is installed (I need the home directory and not the directory where
the executable binary is present) [usrlocaljdk150]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where Java installation is located (rrdjtool is a java library so Java is required for building)
bull Default usrlocaljdk150 bull Recommendation The path in square brackets in only an example
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
perfSONAR 21 11
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter a URL of eXist web application package (exist-101war) [2]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example rrdmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank)
perfSONAR 21 12
perfSONAR 20 Administration Guide Installing perfSONAR 20
everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2412 Configuration
Enter the path of rrd metadata configuration file [rootperfSONAR-RRD-MA-20perfsonarconfrrd-database_TESTxml]
bull Explanation The script asks for the metadata configuration file This file contains the description of measurement data in RRD files If you wanted to use the xml database in the pre-install step then the metadata configuration file will be stored there later on during the Deployment
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in RRD files
bull Default none
Enter location of new RRD files created when measurement data is sent to the service [rootwebapps]
bull Explanation The service can receive messages with measurement data and store them in RRD files Here the script asks for the location where the service will create new RRD files
bull Default ltcurrent_directorygtwebapps
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
2413 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
perfSONAR 21 13
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-RRD-MA-20
[echo] docBase=rootwebappsperfSONAR-RRD-MA-20gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that Tomcat is running
[echo] You can do it using your web browser and connect the address http1270018080
[echo] or looking at Tomcats log file (rootapache-tomcat-607logscatalinaout)
Press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
Do you want me to add new user (provided in the pre-install step) and initiate the xml database eXist (If your eXist
is already configured and initialized for RRD MA answer n But probably its your first run of this installation script
so you have not added this user and initialized the database yet) (yn)
bull Explanation In case of use of the xml database eXist it needs to be set up (this means it must have an account and the metadata configuration specified in the pre-install and configure steps of the installation procedure)
bull Default none bull Recommendation If the xml database already has been set up the answer should be n
perfSONAR 21 14
perfSONAR 20 Administration Guide Installing perfSONAR 20
242 SQL Measurement Archive
2421 Pre-install step
Enter the name of the service [perfSONAR-SQL-MA-10]
bull Explanation - The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-SQL-MA-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [3]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
perfSONAR 21 15
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
IF answer is y Enter a URL of eXist web application package (exist-101war) [4]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
perfSONAR 21 16
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example sqlmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank) everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2422 Configuration
[echo] This service requires access to the relational database
[echo] (mySQL or postgeSQL but others can be used as well)
[echo] Make sure that you have one or install it from scratch
Please do it now and press Enter when finished
bull Explanation The script wants to know if a relational database is installed on the system If you already have one installed just press Enter If not please install one at this point and then press Enter so that the script can continue the installation of the service
bull Default none
[echo] In order to maintain data of utilization metric andor L2 path status metric
[echo] please prepare your relational database
[echo] In case of mySQL use simple script file mysql-sqlma-dbsetupsql
[echo] that you can find in conf directory (rootperfSONAR-SQL-MA-10perfsonarconf)
[echo] of perfSONAR SQL MA installation package
perfSONAR 21 17
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [1]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation This is the port number that will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you need another port number then you must also setup Tomcat to use this
new number To do this open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Do you want me to compile rrdjtool library for you (if not you will have to do it manually in
rootperfSONAR-RRD-MA-20perfsonarcontribrrdjtool after pre-install step) (yn)
bull Explanation The service needs the library of rrdjtool which is an interface to RRD files The script can build the library for you if the answer is y
bull Default none
IF answer is y Enter operating system type (linuxlinux-64bitfreebsdsolarisother)
perfSONAR 21 10
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information what OS do you have on your machine You can find a list of accepted operating systems in round brackets
bull Default none
IF answer is y Enter the directory path where header file of the rrdtool (rrdh) can be found [usrlocalrrdtoolinclude]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where the header file of rrdtool is located
bull Default usrlocalrrdtoolinclude bull Recommendation The path in square brackets in only an example
IF answer is y Enter the directory path where library files of the rrdtool (librrd) can be found [usrlocalrrdtoollib]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where library files of rrdtool are located
bull Default usrlocalrrdtoollib bull Recommendation The path in square brackets in only an example
IF answer is y Enter the home directory where the Java is installed (I need the home directory and not the directory where
the executable binary is present) [usrlocaljdk150]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where Java installation is located (rrdjtool is a java library so Java is required for building)
bull Default usrlocaljdk150 bull Recommendation The path in square brackets in only an example
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
perfSONAR 21 11
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter a URL of eXist web application package (exist-101war) [2]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example rrdmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank)
perfSONAR 21 12
perfSONAR 20 Administration Guide Installing perfSONAR 20
everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2412 Configuration
Enter the path of rrd metadata configuration file [rootperfSONAR-RRD-MA-20perfsonarconfrrd-database_TESTxml]
bull Explanation The script asks for the metadata configuration file This file contains the description of measurement data in RRD files If you wanted to use the xml database in the pre-install step then the metadata configuration file will be stored there later on during the Deployment
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in RRD files
bull Default none
Enter location of new RRD files created when measurement data is sent to the service [rootwebapps]
bull Explanation The service can receive messages with measurement data and store them in RRD files Here the script asks for the location where the service will create new RRD files
bull Default ltcurrent_directorygtwebapps
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
2413 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
perfSONAR 21 13
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-RRD-MA-20
[echo] docBase=rootwebappsperfSONAR-RRD-MA-20gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that Tomcat is running
[echo] You can do it using your web browser and connect the address http1270018080
[echo] or looking at Tomcats log file (rootapache-tomcat-607logscatalinaout)
Press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
Do you want me to add new user (provided in the pre-install step) and initiate the xml database eXist (If your eXist
is already configured and initialized for RRD MA answer n But probably its your first run of this installation script
so you have not added this user and initialized the database yet) (yn)
bull Explanation In case of use of the xml database eXist it needs to be set up (this means it must have an account and the metadata configuration specified in the pre-install and configure steps of the installation procedure)
bull Default none bull Recommendation If the xml database already has been set up the answer should be n
perfSONAR 21 14
perfSONAR 20 Administration Guide Installing perfSONAR 20
242 SQL Measurement Archive
2421 Pre-install step
Enter the name of the service [perfSONAR-SQL-MA-10]
bull Explanation - The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-SQL-MA-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [3]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
perfSONAR 21 15
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
IF answer is y Enter a URL of eXist web application package (exist-101war) [4]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
perfSONAR 21 16
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example sqlmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank) everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2422 Configuration
[echo] This service requires access to the relational database
[echo] (mySQL or postgeSQL but others can be used as well)
[echo] Make sure that you have one or install it from scratch
Please do it now and press Enter when finished
bull Explanation The script wants to know if a relational database is installed on the system If you already have one installed just press Enter If not please install one at this point and then press Enter so that the script can continue the installation of the service
bull Default none
[echo] In order to maintain data of utilization metric andor L2 path status metric
[echo] please prepare your relational database
[echo] In case of mySQL use simple script file mysql-sqlma-dbsetupsql
[echo] that you can find in conf directory (rootperfSONAR-SQL-MA-10perfsonarconf)
[echo] of perfSONAR SQL MA installation package
perfSONAR 21 17
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information what OS do you have on your machine You can find a list of accepted operating systems in round brackets
bull Default none
IF answer is y Enter the directory path where header file of the rrdtool (rrdh) can be found [usrlocalrrdtoolinclude]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where the header file of rrdtool is located
bull Default usrlocalrrdtoolinclude bull Recommendation The path in square brackets in only an example
IF answer is y Enter the directory path where library files of the rrdtool (librrd) can be found [usrlocalrrdtoollib]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where library files of rrdtool are located
bull Default usrlocalrrdtoollib bull Recommendation The path in square brackets in only an example
IF answer is y Enter the home directory where the Java is installed (I need the home directory and not the directory where
the executable binary is present) [usrlocaljdk150]
bull Explanation If you wanted the script to build the library of rrdjtool then you must provide the information where Java installation is located (rrdjtool is a java library so Java is required for building)
bull Default usrlocaljdk150 bull Recommendation The path in square brackets in only an example
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
perfSONAR 21 11
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter a URL of eXist web application package (exist-101war) [2]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example rrdmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank)
perfSONAR 21 12
perfSONAR 20 Administration Guide Installing perfSONAR 20
everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2412 Configuration
Enter the path of rrd metadata configuration file [rootperfSONAR-RRD-MA-20perfsonarconfrrd-database_TESTxml]
bull Explanation The script asks for the metadata configuration file This file contains the description of measurement data in RRD files If you wanted to use the xml database in the pre-install step then the metadata configuration file will be stored there later on during the Deployment
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in RRD files
bull Default none
Enter location of new RRD files created when measurement data is sent to the service [rootwebapps]
bull Explanation The service can receive messages with measurement data and store them in RRD files Here the script asks for the location where the service will create new RRD files
bull Default ltcurrent_directorygtwebapps
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
2413 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
perfSONAR 21 13
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-RRD-MA-20
[echo] docBase=rootwebappsperfSONAR-RRD-MA-20gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that Tomcat is running
[echo] You can do it using your web browser and connect the address http1270018080
[echo] or looking at Tomcats log file (rootapache-tomcat-607logscatalinaout)
Press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
Do you want me to add new user (provided in the pre-install step) and initiate the xml database eXist (If your eXist
is already configured and initialized for RRD MA answer n But probably its your first run of this installation script
so you have not added this user and initialized the database yet) (yn)
bull Explanation In case of use of the xml database eXist it needs to be set up (this means it must have an account and the metadata configuration specified in the pre-install and configure steps of the installation procedure)
bull Default none bull Recommendation If the xml database already has been set up the answer should be n
perfSONAR 21 14
perfSONAR 20 Administration Guide Installing perfSONAR 20
242 SQL Measurement Archive
2421 Pre-install step
Enter the name of the service [perfSONAR-SQL-MA-10]
bull Explanation - The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-SQL-MA-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [3]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
perfSONAR 21 15
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
IF answer is y Enter a URL of eXist web application package (exist-101war) [4]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
perfSONAR 21 16
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example sqlmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank) everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2422 Configuration
[echo] This service requires access to the relational database
[echo] (mySQL or postgeSQL but others can be used as well)
[echo] Make sure that you have one or install it from scratch
Please do it now and press Enter when finished
bull Explanation The script wants to know if a relational database is installed on the system If you already have one installed just press Enter If not please install one at this point and then press Enter so that the script can continue the installation of the service
bull Default none
[echo] In order to maintain data of utilization metric andor L2 path status metric
[echo] please prepare your relational database
[echo] In case of mySQL use simple script file mysql-sqlma-dbsetupsql
[echo] that you can find in conf directory (rootperfSONAR-SQL-MA-10perfsonarconf)
[echo] of perfSONAR SQL MA installation package
perfSONAR 21 17
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter a URL of eXist web application package (exist-101war) [2]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example rrdmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank)
perfSONAR 21 12
perfSONAR 20 Administration Guide Installing perfSONAR 20
everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2412 Configuration
Enter the path of rrd metadata configuration file [rootperfSONAR-RRD-MA-20perfsonarconfrrd-database_TESTxml]
bull Explanation The script asks for the metadata configuration file This file contains the description of measurement data in RRD files If you wanted to use the xml database in the pre-install step then the metadata configuration file will be stored there later on during the Deployment
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in RRD files
bull Default none
Enter location of new RRD files created when measurement data is sent to the service [rootwebapps]
bull Explanation The service can receive messages with measurement data and store them in RRD files Here the script asks for the location where the service will create new RRD files
bull Default ltcurrent_directorygtwebapps
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
2413 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
perfSONAR 21 13
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-RRD-MA-20
[echo] docBase=rootwebappsperfSONAR-RRD-MA-20gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that Tomcat is running
[echo] You can do it using your web browser and connect the address http1270018080
[echo] or looking at Tomcats log file (rootapache-tomcat-607logscatalinaout)
Press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
Do you want me to add new user (provided in the pre-install step) and initiate the xml database eXist (If your eXist
is already configured and initialized for RRD MA answer n But probably its your first run of this installation script
so you have not added this user and initialized the database yet) (yn)
bull Explanation In case of use of the xml database eXist it needs to be set up (this means it must have an account and the metadata configuration specified in the pre-install and configure steps of the installation procedure)
bull Default none bull Recommendation If the xml database already has been set up the answer should be n
perfSONAR 21 14
perfSONAR 20 Administration Guide Installing perfSONAR 20
242 SQL Measurement Archive
2421 Pre-install step
Enter the name of the service [perfSONAR-SQL-MA-10]
bull Explanation - The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-SQL-MA-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [3]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
perfSONAR 21 15
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
IF answer is y Enter a URL of eXist web application package (exist-101war) [4]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
perfSONAR 21 16
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example sqlmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank) everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2422 Configuration
[echo] This service requires access to the relational database
[echo] (mySQL or postgeSQL but others can be used as well)
[echo] Make sure that you have one or install it from scratch
Please do it now and press Enter when finished
bull Explanation The script wants to know if a relational database is installed on the system If you already have one installed just press Enter If not please install one at this point and then press Enter so that the script can continue the installation of the service
bull Default none
[echo] In order to maintain data of utilization metric andor L2 path status metric
[echo] please prepare your relational database
[echo] In case of mySQL use simple script file mysql-sqlma-dbsetupsql
[echo] that you can find in conf directory (rootperfSONAR-SQL-MA-10perfsonarconf)
[echo] of perfSONAR SQL MA installation package
perfSONAR 21 17
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2412 Configuration
Enter the path of rrd metadata configuration file [rootperfSONAR-RRD-MA-20perfsonarconfrrd-database_TESTxml]
bull Explanation The script asks for the metadata configuration file This file contains the description of measurement data in RRD files If you wanted to use the xml database in the pre-install step then the metadata configuration file will be stored there later on during the Deployment
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in RRD files
bull Default none
Enter location of new RRD files created when measurement data is sent to the service [rootwebapps]
bull Explanation The service can receive messages with measurement data and store them in RRD files Here the script asks for the location where the service will create new RRD files
bull Default ltcurrent_directorygtwebapps
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
2413 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
perfSONAR 21 13
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-RRD-MA-20
[echo] docBase=rootwebappsperfSONAR-RRD-MA-20gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that Tomcat is running
[echo] You can do it using your web browser and connect the address http1270018080
[echo] or looking at Tomcats log file (rootapache-tomcat-607logscatalinaout)
Press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
Do you want me to add new user (provided in the pre-install step) and initiate the xml database eXist (If your eXist
is already configured and initialized for RRD MA answer n But probably its your first run of this installation script
so you have not added this user and initialized the database yet) (yn)
bull Explanation In case of use of the xml database eXist it needs to be set up (this means it must have an account and the metadata configuration specified in the pre-install and configure steps of the installation procedure)
bull Default none bull Recommendation If the xml database already has been set up the answer should be n
perfSONAR 21 14
perfSONAR 20 Administration Guide Installing perfSONAR 20
242 SQL Measurement Archive
2421 Pre-install step
Enter the name of the service [perfSONAR-SQL-MA-10]
bull Explanation - The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-SQL-MA-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [3]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
perfSONAR 21 15
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
IF answer is y Enter a URL of eXist web application package (exist-101war) [4]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
perfSONAR 21 16
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example sqlmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank) everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2422 Configuration
[echo] This service requires access to the relational database
[echo] (mySQL or postgeSQL but others can be used as well)
[echo] Make sure that you have one or install it from scratch
Please do it now and press Enter when finished
bull Explanation The script wants to know if a relational database is installed on the system If you already have one installed just press Enter If not please install one at this point and then press Enter so that the script can continue the installation of the service
bull Default none
[echo] In order to maintain data of utilization metric andor L2 path status metric
[echo] please prepare your relational database
[echo] In case of mySQL use simple script file mysql-sqlma-dbsetupsql
[echo] that you can find in conf directory (rootperfSONAR-SQL-MA-10perfsonarconf)
[echo] of perfSONAR SQL MA installation package
perfSONAR 21 17
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-RRD-MA-20
[echo] docBase=rootwebappsperfSONAR-RRD-MA-20gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that Tomcat is running
[echo] You can do it using your web browser and connect the address http1270018080
[echo] or looking at Tomcats log file (rootapache-tomcat-607logscatalinaout)
Press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
Do you want me to add new user (provided in the pre-install step) and initiate the xml database eXist (If your eXist
is already configured and initialized for RRD MA answer n But probably its your first run of this installation script
so you have not added this user and initialized the database yet) (yn)
bull Explanation In case of use of the xml database eXist it needs to be set up (this means it must have an account and the metadata configuration specified in the pre-install and configure steps of the installation procedure)
bull Default none bull Recommendation If the xml database already has been set up the answer should be n
perfSONAR 21 14
perfSONAR 20 Administration Guide Installing perfSONAR 20
242 SQL Measurement Archive
2421 Pre-install step
Enter the name of the service [perfSONAR-SQL-MA-10]
bull Explanation - The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-SQL-MA-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [3]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
perfSONAR 21 15
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
IF answer is y Enter a URL of eXist web application package (exist-101war) [4]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
perfSONAR 21 16
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example sqlmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank) everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2422 Configuration
[echo] This service requires access to the relational database
[echo] (mySQL or postgeSQL but others can be used as well)
[echo] Make sure that you have one or install it from scratch
Please do it now and press Enter when finished
bull Explanation The script wants to know if a relational database is installed on the system If you already have one installed just press Enter If not please install one at this point and then press Enter so that the script can continue the installation of the service
bull Default none
[echo] In order to maintain data of utilization metric andor L2 path status metric
[echo] please prepare your relational database
[echo] In case of mySQL use simple script file mysql-sqlma-dbsetupsql
[echo] that you can find in conf directory (rootperfSONAR-SQL-MA-10perfsonarconf)
[echo] of perfSONAR SQL MA installation package
perfSONAR 21 17
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
242 SQL Measurement Archive
2421 Pre-install step
Enter the name of the service [perfSONAR-SQL-MA-10]
bull Explanation - The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-SQL-MA-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [3]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
perfSONAR 21 15
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
IF answer is y Enter a URL of eXist web application package (exist-101war) [4]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
perfSONAR 21 16
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example sqlmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank) everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2422 Configuration
[echo] This service requires access to the relational database
[echo] (mySQL or postgeSQL but others can be used as well)
[echo] Make sure that you have one or install it from scratch
Please do it now and press Enter when finished
bull Explanation The script wants to know if a relational database is installed on the system If you already have one installed just press Enter If not please install one at this point and then press Enter so that the script can continue the installation of the service
bull Default none
[echo] In order to maintain data of utilization metric andor L2 path status metric
[echo] please prepare your relational database
[echo] In case of mySQL use simple script file mysql-sqlma-dbsetupsql
[echo] that you can find in conf directory (rootperfSONAR-SQL-MA-10perfsonarconf)
[echo] of perfSONAR SQL MA installation package
perfSONAR 21 17
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Usage of eXist xml database is recommended for the service Installingconfiguring this database as a web application in your
Tomcat is also suggested Do you want me to do this for you (yn)
bull Explanation The service contains the metadata configuration which is suggested to be stored in the xml database eXist If you want to have the metadata configuration as a plain text file you may expect that the service will be slower in generating responses Using eXist as a web application you can use your Tomcat to install the xml database
bull Default none
IF answer is y Do you want me to download eXist web application package (if not you have to do it manually) (yn)
bull Explanation The script can download xml database eXist as a web application package automatically It is possible that the time of downloading might be long In such case download eXist manually
bull Default none
IF answer is y Enter a URL of eXist web application package (exist-101war) [4]
bull Explanation If you wanted the script to download eXist then you can see a suggested server to be used for downloading
bull Default httpprdownloadssourceforgenetexistexist-101war
IF answer is y Enter the path of directory where eXist war file will be located [root]
bull Explanation If you wanted the script to download eXist then you can see the suggested location where eXist will be stored
bull Default ltcurrent_directorygt
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=exist
[echo] docBase=rootexist-101wargt
[echo] ltContextgt
Please do it now and press Enter when finished
perfSONAR 21 16
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example sqlmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank) everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2422 Configuration
[echo] This service requires access to the relational database
[echo] (mySQL or postgeSQL but others can be used as well)
[echo] Make sure that you have one or install it from scratch
Please do it now and press Enter when finished
bull Explanation The script wants to know if a relational database is installed on the system If you already have one installed just press Enter If not please install one at this point and then press Enter so that the script can continue the installation of the service
bull Default none
[echo] In order to maintain data of utilization metric andor L2 path status metric
[echo] please prepare your relational database
[echo] In case of mySQL use simple script file mysql-sqlma-dbsetupsql
[echo] that you can find in conf directory (rootperfSONAR-SQL-MA-10perfsonarconf)
[echo] of perfSONAR SQL MA installation package
perfSONAR 21 17
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the file as described on another window then press Enter so that the script can continue the installation
bull Default none
Enter the eXist user name
bull Explanation The script asks for xml database user name (it could be for example sqlmaservice) bull Default none
Enter the password for eXist user name
bull Explanation The script asks for the password for xml database user bull Default none
Enter the password for admin eXist user []
bull Explanation The script asks for the password for xml database admin user bull Default If this is the first installation of eXist then the password is empty bull Recommendation We suggest you changeset up the password for admin user of eXist database
after the service installation procedure When the eXist database password is not set (blank) everyone can alter the content of the database using eXist client application (of course if a firewall does not block the access)
2422 Configuration
[echo] This service requires access to the relational database
[echo] (mySQL or postgeSQL but others can be used as well)
[echo] Make sure that you have one or install it from scratch
Please do it now and press Enter when finished
bull Explanation The script wants to know if a relational database is installed on the system If you already have one installed just press Enter If not please install one at this point and then press Enter so that the script can continue the installation of the service
bull Default none
[echo] In order to maintain data of utilization metric andor L2 path status metric
[echo] please prepare your relational database
[echo] In case of mySQL use simple script file mysql-sqlma-dbsetupsql
[echo] that you can find in conf directory (rootperfSONAR-SQL-MA-10perfsonarconf)
[echo] of perfSONAR SQL MA installation package
perfSONAR 21 17
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
[echo] In case of postgreSQL use psql-sqlma-dbsetupsql
[echo] (Warning remember to change the password for perfsonar_ma user)
Please do it now and press Enter when finished
bull Explanation The script wants the relational database to be ready to receive the data of the metrics that work with the service If the database is mySQL the user should use the script mysql-sqlma-dbsetupsql In case of a postgreSQL database use psql-sqlma-dbsetupsql Then press Enter so that the script can continue the installation of the service
bull Default none
Enter the path of sql metadata config file [rootperfSONAR-SQL-MA-10perfsonarconfsql-database_TESTxml]
bull Explanation The script asks for the location of the metadata configuration file This file contains the description of measurement data stored in relation database
bull Default The test file in square brackets is suggested only for test purposes (you can use it for the first test service installation)
Do you want to use data of L2 path status metric in domain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - domain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric bull Default none
Enter the name of database you are going to use (mysqlpostgresql)
bull Explanation The script wants to know the relational database that is going to be used bull Default none
Enter database jdbc address URL [jdbcmysql127001perfsonar_ma]
bull Explanation The script wants to know the jdbc address URL to the relational database bull Default jdbcmysql127001perfsonar_ma
Enter database user name [perfsonar_ma]
bull Explanation The script asks for relational database user name bull Default it could be for example perfsonar_ma
Enter the password of user name perfsonar_ma [testpass]
bull Explanation The script asks for relational database password for the username chosen in the previous step
perfSONAR 21 18
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Default it could be for example testpass
Do you want to use data of L2 path status metric in interdomain scope which are or will be stored in your relational database (yn)
[echo] Provide correct jdbc connection parameters
[echo] for relational database where data of L2 path status metric - interdomain scope
[echo] are stored
bull Explanation The script asks if the user wants to use the L2 path status metric in intradomain scope
bull Default none
Do you want to use data of utilization metric which are or will be stored in your relational database (yn)
bull Explanation The script asks if the user wants to use the utilization metric bull Default none
[echo] If you want to change provided jdbc connection parameters manually
[echo] because of some reasons
[echo] you can do this in configuration files (ibatis-SqlMapConfig-xml)
[echo] in rootperfSONAR-SQL-MA-10-RC5perfsonarconf directory
[echo] After such change when the service is already deployed you must
[echo] redeploy the service (undeploy and deploy again)
Press Enter to continue
bull Explanation The script asks if the user wants to change jdbc parameters manually bull Default none
Do you want the service to accept messages with measurement data and store them (yn)
bull Explanation The service can receive messages with measurement data and store them in relational database
bull Default none
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y Enter the URL of LS []
perfSONAR 21 19
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2423 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deployment you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-SQL-MA-10
[echo] docBase=rootwebappsperfSONAR-SQL-MA-10gt
[echo] ltContextgt
Please do it now and press Enter when finished
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Do the change on the
perfSONAR 21 20
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
file as described on another window then press Enter so that the script can continue the installation
bull Default none
[echo] (Re)Start the Tomcat
[echo] Please make sure that Tomcat is running
Please do it now and press Enter when finished
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
243 Lookup Service
2431 Pre-installation
[echo] Requirements
[echo] 1 Java 15x
[echo] 2 Ant 16x (were sure youve already got it installed as you run the installation process)
[echo] 3 eXist DB XML - see Exist DB Installation Guide for LS
[echo] httpwikiperfsonarnetjra1-wikiindexphpExist_DB_Installation_Guide_for_LS
[echo] 4 JAVA_HOME environment variable set to your Java directory
Do you want to proceed Just press ENTER to continue Otherwise CTRL-C stops the process immediately
bull Explanation The script will ask you to check if you have all the required software pre-installed in the host If you dont please install it and then press Enter
bull Default none bull Recommendation We suggest users to changeset up the password for admin user of eXist
database after the service installation procedure When the eXist has been installed by default the password is not set (blank) This way every one can alter the content of the database using eXist client application (of course if the firewall does not block open access)
Do you want to download Tomcat webserver automatically (say N if youve already got Tomcat)(yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
perfSONAR 21 21
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter webserver (Tomcat) home directory If answered Y for previous question this directory will be the target directory
where to install Tomcat If answered N Tomcat will be installed there [usrlocaltomcat_ls]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default usrlocaltomcat_ls
Enter webserver port [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
Service directory is suffix is [XML-LS-11] Enter service prefix directory (where target directory XML-LS-11 will be installed)
Default is [rootpswebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
[echo] ---------------------------------------------------------------
[echo] Your settings
[echo] ---------------------------------------------------------------
[echo] Tomcat home directory [usrlocaltomcat_ls]
[echo] Tomcat address [5]
[echo] Service destination directory [rootpswebappsXML-LS-11-RC6]
Proceed with these settings (yn)
bull Explanation The script will ask you to check the selected settings bull Default none
2432 Configuration
[echo] 2 Lookup Information configuration
[echo] =====================================
Enter hostname and domainname of your machine Not localhost [mycomputermydomaincom]
bull Explanation The script will ask you to enter the hostname and domain name of your machine for Lookup service information
bull Default mycomputermydomaincom
perfSONAR 21 22
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Recommendation This should be your full hostdomain such as alfadomaincom
Lookup Information of service -- access point (URL) [6]
bull Explanation The script will ask you to enter the url for accessing the Lookup service bull Default httpmycomputermydomaincom8080XML-LS-11
Lookup Information of service -- service name [Test Lookup Service]
bull Explanation The script will ask you to enter the identification name for the Lookup service bull Default Test Lookup Service
Lookup Information of service -- service type [LS]
bull Explanation The script will ask you to enter the service type bull Default LS
Lookup Information of service -- service description [Test Lookup Service perfSONAR]
bull Explanation The script will ask you to enter the service description bull Default Test Lookup Service perfSONAR
[echo] 3 LS Storage
[echo] =====================================
LS Storage -- XML database type (preferred one is HTTP because its much faster)(httpxmlrpc)
bull Explanation The script will ask you to enter XLM database type that the service will use bull Default none
LS Storage -- XML database collection [7]
bull Explanation The script will ask you to enter the location of the XLM database collection which will be set automatically
bull Default httplocalhost8680existrestdbls bull Recommendation Be sure to choose right protocol for your previous choice (http for http
existxmldb for xmlrpc)
LS Storage -- XML database username [lookupservice]
bull Explanation The script asks for xml database user name (it could be for example lookupservice) bull Default lookupservice
LS Storage -- XML database password [sonar]
perfSONAR 21 23
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The script asks for the password for xml database user (it could be for example sonar)
bull Default sonar
[echo] 4 LS Cleanup
[echo] =====================================
LS Cleanup -- enable LS Cleanup (removing old entries when TTL exceeded)(yn)
bull Explanation Choose y if you want to enable LSCleanup that will remove old entries of services that register with the Lookup Service if their TTL (time to live) is exceeded
bull Default none
LS Cleanup -- cleanup interval how often to search old entries in DB [300] (seconds)
bull Explanation The script asks for how often in seconds the Lookup service will search for old entries among the registered services
bull Default 300 seconds (5 minutes)
LS Cleanup -- TTL of lookup information [3600] (seconds)
bull Explanation The script asks for the value of the TTL (time to live) that is the time interval in which registered services have to renew their registration information on the Lookup service If they dont they will be considered old entries
bull Default 3600 seconds (1 hour)
2433 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcat_lsconfserverxml)
[echo] inside existing xml tag Host
[echo] (You may copy XML part (without [echo])
[echo] ltContext path=XML-LS-11-RC6 docBase=rootpswebappsXML-LS-11-RC6gt ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 24
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described and then press Enter so that the script can continue the installation
bull Default none
[echo] Execute sh usrlocaltomcat_lsbinstartupsh
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
bull Explanation The script will ask you to check if Tomcat has finished its startup phase You can use web browser and connect to your Tomcats web page or take a look at Tomcats log file logscatalinaout (after startup phase you should find there a line INFO Server startup in xxx ms) then press Enter so that the script can continue the installation
bull Default none
244 SSHTelnet Measurement Point
2441 Pre-installation
Enter the name of the service [JAVA-SSHTELNET-MP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default JAVA-SSHTELNET-MP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation Location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
perfSONAR 21 25
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [8]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] Make sure that your application server Tomcat has the same port
[echo] for the http communication If not then configure the Tomcat in order
[echo] to use this port number
Please do it now and press Enter when finished
2442 Configuration
Do you already have a manually edited serviceconfiguration files available (yesno)
bull Explanation The service asks for a previously available configuration file If you answer yes the service will ask for the path to the file and use that one as configuration file If the answer is negative a new configuration file will be created based on the answers provided on the following questions
bull Default none
IF answer is yes
Please enter the path to this configuration file
perfSONAR 21 26
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation One has to enter the path to the manually edited configuration file The configuration now moves on to the register-functionality-question
bull Default none
IF answer is no
Enter the name of the devices one by one end the list with STOP
bull Explanation First the names of the devices that have to be supported will be asked Here you can specify anything you like but mostly this is the URL or the hostname of the machine
bull Default none
Choose one of the following types of equipment for every device specified previously
1) Quagga - Password Login (Telnet)
2) Cisco - Password Login (Telnet)
3) Cisco - Password Login (SSH)
4) Cisco - Key-based Login (SSH)
5) Juniper - Password Login (Telnet)
6) Juniper - Password Login (SSH)
7) Juniper - Key-based Login (SSH)
bull Explanation For every device previously specified you have to choose one of the provided types of equipment According to the chosen type of device and access method some more questions will be asked to configure the URL port username password or key prompt and access-rate
bull Default none
IF device is of type 1
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
perfSONAR 21 27
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
Please give the bgp-daemon port for device
bull Explanation Enter the BGP Deamon port for the device specified bull Default none
Please give the bgp-daemon prompt for device
bull Explanation Enter the BGP Deamon prompt for the device specified bull Default none
Please give the bgp-daemon password for device
bull Explanation Enter the BGP Deamon password for the device specified bull Default none
IF device is of type 2 3 5 or 6
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
perfSONAR 21 28
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the password for device
bull Explanation Enter the password for the device specified bull Default none
IF device is of type 4 or 7
Please give the url for device
bull Explanation Enter the URL for the device specified bull Default none
Please give the port for device
bull Explanation Enter the port for the device specified bull Default none
Please give the prompt for device
bull Explanation Enter the prompt for the device specified bull Default none
Please give the access rate for device
bull Explanation Enter the access rate for the device specified The access rate is the minimum interval between requests (in ms)
bull Default none
Please give the username for device
bull Explanation Enter the username for the device specified bull Default none
Please give the path to the public ssh key for device
bull Explanation Enter the path to the public ssh key for the device specified bull Default none
After configuring the devices the commands for these devices need to be configured
Enter the name of the commands you want the users to be able to execute on the device one by one for every device to end the list enter STOP
perfSONAR 21 29
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
You can choose these names yourself
Start the command with BGP_ for BGP-commands
Start the command with IP_ for IP-commands
Start the command with IPv6_ for IPv6-commands
Start the command with STATUS_ for STATUS-commands
bull Explanation The last big part of the configuration script asks you what the names are for all the commands you want the users to be able to execute on the device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same commands as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device The same question will be asked again but this one only encompasses the symbolic names of the commands
bull Default no
IF the current device is the first one or the answer is no
Enter the commands
bull Explanation Enter the symbolic names of the commands you want to be supported by the current device These names should be preceded by BGP_ IP_ IPv6_ STATUS_ for their respective type of information
bull Default none
IF the current device is not the first one to be configured
Do you want the use the same properties as configured for the previous device (yes[no])
bull Explanation If the commands for a previous device were already configured you now have the option to use the same configuration for the commands of the current device Whereas previously this question encompassed only the symbolic names of the commands this time it encompasses the configuration of these commands
bull Default no
IF the current device is the first one or the answer is no
Device specific command to be executed for command ltcurrent_commandgt
bull Explanation Enter the specific command to be executed This has to be the exact command which will be sent to the device (minus the arguments)
bull Default none
perfSONAR 21 30
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
Minimum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the minimum number of parameters for the current command bull Default 0
Maximum number of parameters for command ltcurrent_commandgt [0]
bull Explanation Enter the maximum number of parameters for the current command bull Default 0
Caching time (ms) ltcurrent_commandgt [0]
bull Explanation Enter the caching time in ms This specifies a time in which the result of the previously executed command is cached If the same command is executed the result will be retrieved from the cache instead of doing the measurement again
bull Default 0
Textual description of the command ltcurrent_commandgt [none]
bull Explanation Enter a textual description for the current command bull Default none
Syntax rules for the command ltcurrent_commandgt [none]
bull Explanation Enter syntax rules for the current command This is a textual representation of how the command should look like
bull Default none
Comma seperated string of regexes for ltcurrent_commandgt [none]
bull Explanation Enter regular expressions for the current command This is the regular expression the command should validate to
bull Default none
register-fuctionality-question
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
IF answer is y
register-fuctionality
Enter the URL of LS []
perfSONAR 21 31
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
Default no url
IF answer is y Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
IF answer is y Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
IF answer is y Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service Default perfSONAR service
2443 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (rootpsapache-tomcat-607confserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=JAVA-SSHTELNET-MP-10
[echo] docBase=rootpswebappsJAVA-SSHTELNET-MP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on
perfSONAR 21 32
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
the file in another window as described then press Enter so that the script can continue the installation
bull Default none
245 Command Line Measurement Point
2451 Pre-installation
Enter the name of the service [perfSONAR-CLMP-10]
bull Explanation The script asks for symbolic name This name will be present in the address URL of the service
bull Default perfSONAR-CLMP-10
Enter the path where you want to install the service [rootwebapps]
bull Explanation location of the service files to be stored bull Default ltcurrent_directorygtwebapps
Do you want me to download and install the application server Tomcat (apache-tomcat-607) for you (yn)
bull Explanation Application server Tomcat is a container for the service It contains the implementation of HTTP protocol which is used by the service to send and receive messages (NMWG) If you already have it in your system you can answer n
bull Default none bull Recommendation Tomcat version 607 is suggested
IF answer is y Enter the path for the Tomcat installation [rootapache-tomcat-607]
bull Explanation If you wanted to download Tomcat then the script asks you where to put it bull Default ltcurrent_directorygtapache-tomcat-607
IF answer is y Enter a URL of the Tomcat download (mirrors can be found on httptomcatapacheorg) [9]
bull Explanation If you wanted to download Tomcat then the script suggests mirror server to be used for downloading
bull Default httparchiveapacheorgdisttomcattomcat-6v607binapache-tomcat-607targz
IF answer is n Enter the path for the Tomcat installation [usrlocaltomcat]
bull Explanation If you already have Tomcat in your system the script asks you where it is located bull Default usrlocaltomcat
perfSONAR 21 33
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
Enter the port which will be used by your application server Tomcat [8080]
bull Explanation The script asks for port number which will be used by Tomcat and the service to send and receive messages (HTTP)
bull Default 8080 bull Recommendation If you want to have other port number then you have to setup Tomcat to use
this new one as well To do it open Tomcats configuration file confserverxml and alter the port number in the Connector element ltConnector port=8080 protocol=HTTP11 maxThreads=150 connectionTimeout=20000redirectPort=8443 gt
[echo] The CL-MP implements simple resource protection limiting
[echo] the number of concurrent processes of a specific tool
[echo] This only applies to a particular tool being the tools
[echo] independent of each other If you want to disable a tool
[echo] define a number less than one for its configuration If
[echo] you dont want any limits hit enter to accept the default
[echo] How many concurrent ping measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent ping measurements bull Default no limit
[echo] How many concurrent traceroute measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent traceroute measurements bull Default no limit
[echo] How many concurrent OWAMP measurements do you want
[enter for no limit]
bull Explanation The script asks for limit number of concurrent OWAMP measurements bull Default no limit
[echo] How many concurrent BWCTL measurements do you want
[input] [enter for no limit]
bull Explanation The script asks for limit number of concurrent BWCTL measurements bull Default no limit
Turn on service registration to Lookup Service (yn)
bull Explanation The service can register itself to the Lookup Service The Lookup Service stores the information about running perfSONAR services in the network
bull Default none
perfSONAR 21 34
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
IF answer is y Enter the URL of LS []
bull Explanation The service can register itself to a Lookup Service The script asks for the url of the Lookup Service on which the service will register itself
bull Default no url
Enter the registration interval [30000]
bull Explanation The service can register itself to a Lookup Service The script asks for the registration interval that the service will use
bull Default 30000
Enter IP or DNS address of the host you are using now to deploy the service []
bull Explanation The service can register itself to a Lookup Service The script asks for the IP address or name of the server where the SQL-MA installation is being done and from where the service will register to the Lookup Service
bull Default none
Enter the description of service that will be send to the LS [perfSONAR service]
bull Explanation The description of the service that will be sent when registering to a Lookup Service bull Default perfSONAR service
2452 Deployment
Do you want me to start the application server Tomcat for you (yn)
bull Explanation The script can start Tomcat with the service inside but there is also a possibility to do it manually
bull Default none bull Recommendation If your Tomcat is already running before Deploy step you should answer n
[echo] Please insert now the following xml tag Context
[echo] into Tomcat configuration file serverxml
[echo] (usrlocaltomcatconfserverxml)
[echo] inside existing xml tag Host
[echo] ltContext path=perfSONAR-CLMP-10
[echo] docBase=rootwebappsperfSONAR-CLMP-10gt
[echo] ltContextgt
[echo] Please do it now I will wait for you
Press Return key
perfSONAR 21 35
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
bull Explanation The Context element represents a web application which is run within a particular virtual host Each web application is based on a Web Application Archive (WAR) file Here we nest a Context element within a HOST element in ltTOMCATgtconfserverxml Perform the change on the file in another window as described then press Enter so that the script can continue the installation
bull Default none
[echo] Please make sure that the Tomcat is running Use the address http1270018080
Press Return key
246 BWCTL Measurement Point
2461 Pre-installation
Starting installation for service BWCTL MP
Choose path for installation of perl perfSONAR [ltcurrent_directorygtwebapps]
bull Explanation The script asks for the path where to install the service bull Default ltcurrent_directorygtwebapps
Checking prerequisites
()
Installing missing modules
We are about to install SOAPLite and for your convenience will provide
you with list of modules and prerequisites so youll be able to choose
only modules you need for your configuration
bull Explanation In this step of the service installation missing perl modules will be installed in the local path of the perfSONAR daemon environment If you want to use your systems mechanism of installing perl modules skip this step In this case you have to ensure yourself that all prerequisites are met
bull Default none
2462 Configuration
Feature Prerequisites Install
----------------------------- ---------------------------- --------
Core Package [] URI always
[] MIMEBase64
[] XMLParser (v223)
perfSONAR 21 36
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
Client HTTP support [] LWPUserAgent [ yes ]
Client HTTPS support [] CryptSSLeay [ yes ]
Client SMTPsendmail support [ ] MIMELite [ no ]
()
--- An asterix [] indicates if the module is currently installed
Do you want to proceed with this configuration [yes] yes
bull Explanation A detailed list of perl modules that exist and that will need to be installed is shown to the user before continuing the installation The script asks if the user wants to proceed with the installation
bull Default yes
Summary
--------
Missing Perl modules
Missing tools
Please make sure that all dependencies are met before you continue the installation
bull Explanation The script checks if all prerequisites are met and reports a list of prerequisites not met (if any)
bull Default none
2463 Deployment
choose usergroup for running perfsonar daemon [perfsonarperfsonar]
bull Explanation The script asks for the usergroup that will be used to run the service bull Default userperfsonar group perfsonar
Apparently the installation was successful
2464 Testing
Would you like to test the service (y n) y
bull Explanation The script asks if the user wants to test the service bull Default none
Test perfsonar demaon
Starting perfsonarpl [ OK ]
Shutting down perfsonarpl [ OK ]
perfSONAR 21 37
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
25 Advanced Installation
There are two ways to do advanced installation for a service
251 With the help of the bundle installer
bull Either after downloading each services installation files or during modification of the existing installation of a service you have the possibility to go for advanced installation process
bull This process gives you the following options for all Services Note Jakarta tomcat is not used by BWCTL MP (as it is written in Perl) All steps below apply to all services (including Java and Perl) but if tomcat is mentioned anywhere please remember that tomcat is internal to bwctl and there is nothing that you need to do with it
bull In order to install a new service you have to follow the steps 1 2 and 3 in sequence bull If you want to re-configure a service you can repeat step 2 at any time but after that you MUST
repeat step 3 otherwise changes wont take effect The same rule applies for any of the steps (for example if you want to repeat step 1 you can
do so but you will have to repeat the later steps in sequence)
1 pre-install
This step allows you to explicity ask for pre-installation step for the particular service
2 configure
This step allows you to configure the service you wish to install If you go wrong you can repeat
If you want to re-configure your service at a later stage DO NOT FORGET to follow step 3 otherwise
your changes wont take effect Finally re-start your tomcat
3 deploy
This step deploys the service on to the tomcat
4 test
This step runs some diagnostic tests To verify the results of the tests
you will usually need to look into the resulting xml to see if there are error messages
Error messages can easily be spotted
5 undeploy
Use this step if you want to undeploy your service It is most suitable if you wish to pull down your service
for a while before putting it back online If you want to remove the service you can follow this step as well
but we recommend that you follow the uninstallation guide
6 enabledisable verbose
This enablesdisables verbose output messages printed onto the screen by the installer
perfSONAR 21 38
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
We dont recommend changing this unless you are diagnosing the service installer
7 restart script
If for some reason you need to start again please choose this option It will take you to the main menu
0 exit
Quit the installer completely
252 With the help of ant or perl scripts which are part of each service
bull All Java services come with Ant targets which help in installation and configuration related aspects of the software Ant targets are available inside the perfsonarant directory of each Java service (for example
XML-LS-11perfsonarant perfSONAR-JAVA_RRD-MA-20perfsonarant) There are a few main ant targets which are built on many smaller ant targets It is possible to
use the smaller ant targets but their usage is not documented for users The list gives the documented ant targets that we expect to be used
bull For SSH telnet MP
You can execute the following commands inside the ant directory
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant configure - This step will help you in configuring the service
- NOTE Do not use -q switch for SSHTelnet MP
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
- NOTE Do not use the -q switch for test targets
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull For Command Line MP RRD MA SQL MA and XML-LS
ant -q pre-install - This step will help you in installing and configuring the pre-requsities
ant -q configure - This step will help you in configuring the service
ant -q deploy - This step will help you in deploying the service
ant test - This step will help you in running some diagnostic tests to see if the installation is ok
ant -q undeploy - This step will undeploy the service (and delete all the deployment related files)
perfSONAR 21 39
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Installing perfSONAR 20
- NOTE Sometimes the webapps directory cannot be deleted
Please shutdown tomcat and delete files manually
bull Perl services use perl for installation
253 Re-configuration
bull Sometimes services need to be re-configured For example when the location of LS changes or when the location of SQL database changes etc There are two ways in which you can re-configure the service which you have already installed With the help of the bundle installer
mdash The bundle installer can help you in modifying existing installations mdash Once you have made your changes make sure you deploy once again Otherwise
changes wont be applied mdash Restart tomcat and Test it out
With the help of the Ant or Perl Installation scripts All services have installation scripts either in Ant or Perl These scripts are used by the bundle
installer script in order to install a particular service If you want to use these scripts directly you can follow the guidelines provided for advanced
installation of perfSONAR services Please note that once you do a step (for example ant configure) you will need to follow all the
remaining steps in sequence Otherwise your changes wont be applied to the deployment bull Sometimes configurations or re-configurations of SQL Databases and eXist XML databases are
required Configuring the MySQL Database
mdash We suggest that you use the freeware SQLyog which provides a powerful front end to the SQL databases
mdash Apart from creating databases tables and indexes and adding removing and modifying data entries it also provides the capability to administer privileges of users and so on
Configuring the exist XML Database mdash To re-configure the service you could also directly amend and then restart tomcat but we
do not recommend this approach for day-to-day administration of perfSONAR services
perfSONAR 21 40
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Stitching
3 Stitching
31 What is Stitching
bull Measurement Archives (RRD MA and SQL MA) require ldquostitchingrdquo to be performed This stitching process (also referred to as configuration) involves defining ldquometa informationrdquo for the network measurement data that will be made available using these services In case of SSH Telnet MP stitching provides information about commands that the MP can allow to be executed
bull Tools (including sample configuration files) and Manuals are available from the perfSONAR wiki pages (httpwikiperfsonarnetjra1-wikiindexphpPerfSONAR_v20) and are included in this guide to help you with this stitching process The stitching process will result in creation of an XML file for your network (at least one per service)
32 RRD MA Stitching
You need to create a data configuration file for your network that will provide information about all the rrd files that you wish to make available to the measurement archive
See the ldquoRRD MA Stitching Guiderdquo for more information
33 SQL MA Stitching (utilisation and lightpath status)
You must configure your SQL MA to provide metadata information about one or both of the following
bull Network interfaces and interface utilisation data bull Network links and status of these links (also known as Lightpath Monitoring or e2eMon)
See the ldquoSQL MA Stitching Guiderdquo for more information
perfSONAR 21 41
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Stitching
34 SSH Telnet MP Stitching
See the ldquoSSH Telnet MP Stitching Guiderdquo for guidance and sample configuration files
perfSONAR 21 42
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Backing up your configurations
4 Backing up your configurations
Once your service is deployed configured and working as expected we suggest that you back up configurations The steps below should help you in this task
bull For all services The Best option is to backup the webapps directory related to a service By default this is
located inside the webapps directory inside the perfsonar-bundle-20 directory For example the directory $perfsonar-bundle-20webappsperfSONAR-RRD-MA-20 is the directory where the deployed RRDMA service is located by default Backing up this directory (~100 Mb) will help in easy restoration of the service when required
Apart from following the option above for RRD MA and SQL MA it is suggested that the metadata configuration file be backed up regularly as well
bull For RRD MA and SQL MA You can download the metadata configuration file that has been currently applied to the service
by using the eXist XML DB web interface To do this mdash Point your browser to the workstation where the service and xml database is installed For
example httpserver_nameportexist mdash Login using the username and password provided during the installation process mdash You should be able to see a list of collections known to the database Browse the
appropriate collection (rrdmaconfig or sqlmaconfig) mdash You should be able to find an xml file Clicking on it will open the file in a new browser
window mdash View the source for that xml file and save the file to a desired location
perfSONAR 21 43
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
5 Upgrading your existing RRD MA and SQL MA metadata configurations
bull RRD MA - Upgrading from perfSONAR-10 See the old sample file at
httpanonsvninternet2edusvnperfsonarbranchesreleaseperfsonarconfrrd-database_TESTxml
See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-MA-20confrrd-database_TESTxml
Replace all eventType elements inside metadata with a parameters block mdash The parameter block should contain a parameter element with name attribute =
supportedEventType For Link Utilisation metric the text for this element will have to be httpggforgnsnmwgcharacteristicutilization20
Add an extra parameter inside the key Parameter has name attribute = valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
bull RRD MA - Upgrading from versions after perfSONAR-10 and before perfSONAR-bundle-20 See the new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-RRD-
MA-20confrrd-database_TESTxml All supportedEventType parameter elements in the metadata elements should be replaced
from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
If all keys do not have a parameter with name attribute valueunits add an extra parameter inside the key Parameter should have an attribute with name valueUnits and text can either be Bps or bps depending on whether your rrd files store data in bits per second or bytes(octests) per second
perfSONAR 21 44
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Upgrading your existing RRD MA and SQL MA metadata configurations
bull SQL MA - Upgrading from pre-release versions (before perfSONAR-bundle-20) For utilisation metric
mdash See an old sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash See a new sample file for 20 at httpanonsvninternet2edusvnperfsonartagsJAVA-SQL-MA-10confsql-database_utilization_TESTxml
mdash All supportedEventType parameter elements in the metadata elements should be replaced from the old value of utilization to the new value of httpggforgnsnmwgcharacteristicutilization20
For path status metric mdash No changes required
perfSONAR 21 45
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Upgrading existing (lt20) perfSONAR software
6 Upgrading existing (lt20) perfSONAR software
Existing software cannot be automatically upgraded If you have an older version of the software installing and would like to install the latest version you will need to uninstall the older version with the help of the uninstallation guide available in this manual and then install the newer version
Note For some services such as RRD MA SQL MA and so on you are advised to backup some existing configuration files otherwise you will end up having to re-write or regenerate them The section on stitching has a sub-section that helps you in backing up your existing configuration files
perfSONAR 21 46
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Uninstallation
7 Uninstallation
71 Uninstalling perfSONAR 10 bundle
bull Backup RRD MA Metadata configuration file You will need to make small format changes to this file if you want to re-use it in 20
bull Delete the perfSONAR 10 directory - make sure you do not delete any rrd data files that you might have stored inside it
bull Inside Jakarta tomcat delete the axis directory (usually present in $TOMCATwebappsaxis) bull If you want to re-use tomcat please remove two configurations in catalinaproperties
You can find this file in $TOMCATconf directory The entries correspond to two lines in catalinaproperties file starting with serviceproperties
and componentsproperties Simply delete the two lines and save the file Restart Jakarta Tomcat
72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
bull Backup configuration files You can find instructions on backing up these files in the section on stitching The following files are important Metadata configuration file for RRD MA Metadata configuration files for SQL MA serviceproperties file for SSHTelnet MP
bull Stop tomcat remove entries in serverxml file serverxml file can be found in $TOMCATconf directory These entries start with ltContext and end with ltContextgt Delete the entry completely - starting with ltContext until and including ltContextgt Make a note of the docBase value so that you can delete that directory as well
mdash Make sure you delete the correct entry for the service that you wish to uninstall bull Remove application configuration file that tomcat automatically generates
They are usually created inside the $TOMCATconfCatalinalocalhost directory Each service usually has an xml file named after it
bull Delete the webapps directory for the particular service
perfSONAR 21 47
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Uninstallation
The serverxml file might have given you some hints on where you had placed this directory bull Delete the service installer directory - Its location depends on where you extracted the tar file while
installing bull Restart tomcat
73 Uninstalling services bundled in 20
731 Uninstalling JAVA Services
bull This section of the guide should be used to uninstall the following services bull RRD MA bull SQL MA bull LS bull TelnetSSH MP bull Command Line MP (CLMP)
1 Undeploy the service Either using the bundle installer (advanced installation or modify existing installation) undeploy the service This undeploy step will try to undeploy the web service and will also try to delete all the files that were copied to the webapps folder (usually perfSONAR-20webapps)
2 Search and remove entry for the particular service in serverxml In the tomcat directory look for the conf directory This conf directory contains a serverxml file During installation of perfSONAR services you would have added some entries into this serverxml config file
In order to stop a particular service it is required to remove lines applicable to that service The lines start with ltContext and end with ltContextgt For example if you were uninstalling RRD MA service look for the appropriate entry as there can be many entries for other services and remove the lines which look like below
ltContext path=perfSONAR-RRD-MA-20-RC6
docBase=homeloukikperfSONARwebappsperfSONAR-RRD-MA-20-RC6gt
ltContextgt
3 Remove appropriate application configuration files which are automatically generated by tomcat For each service deployed in tomcat Tomcat automatically generates an xml file It stores these files in $TOMCATconfCatalinalocalhost Identify such files by server names and delete the ones appropriate If you delete any other it should still be fine as tomcat regenerates them
4 Optionally backup and remove contents in eXist XML Database This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database You can usually find the eXist database on the same tomcat as other services - http$SERVER_NAME$PORTexist Log in as administrator (scroll down left menu bar) We suggest that you back-up any configurations so that they can be used if needed later on Delete any users that were created for these services and also delete any collections that might have been created for the service that you wish to uninstall
5 Optionally Search and remove entry for eXist Database in serverxml This applies for RRD MA SQL MA and LS only There is usually no harm in leaving the content on the xml database DO NOT FOLLOW THIS STEP IF any other service installation requires the same xml database installation
perfSONAR 21 48
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-
perfSONAR 20 Administration Guide Uninstallation
6 Optionally delete the webapps folder WARNING IF YOU DELETE THE FOLDER COMPLETELY all installed services will be removed You will have to start installations and configurations from scratch If you really want to do this we suggest that you back-up any configuration files
Ideally for the service that you wish to uninstall identify the folder inside the webapps folder (usually perfSONAR-20webapps) and delete that particular folder
7 Optionally delete the service installer You can delete the specific service installer that you wish to uninstall It is usually present as a directory inside the perfSONAR-20 directory You can also delete the perfSONAR bundle installer if you do not wish to use perfSONAR anymore
732 Uninstalling Perl Services
This section of the guide describes how to uninstall
bull BWCTL MP
1 Undeploy the service Use the undeploy script to remove the service from linuxfedora hosts The undeploy script performs the following steps
Stops the service if it is still running Deletes the service implementation files and the corresponding folder Deletes all locally (only for this service) installed perl modules from the system
2 Cleaning up You can perform all these steps by hand also Note that the bwctl and iperf applications are not deleted automatically as these may be part of the host system independent from the BWCTL perfSONAR MP
74 Uninstalling perfSONAR 20 bundle
bull Please make sure that you backup any configurations andor data that you might need for future bull Uninstall each service (specifically remove entries from tomcats serverxml) - see uninstallation of
20 guide above bull Delete the webapps directory (By default this is located in perfSONAR-20webapps) bull Delete the perfSONAR 20 bundle directory bull Shutdown tomcat and either delete the tomcat folder (if not needed anymore) or restart it
perfSONAR 21 49
- 1 Introduction
-
- 11 How To Use This Guide
-
- 111 Document Conventions
-
- 12 Introducing perfSONAR 20
-
- 2 Installing perfSONAR 20
-
- 21 Points To Consider
- 22 perfSONAR 20 Prerequisites
-
- 221 Manual Installation of pre-requisites
-
- 2211 General Requirements
- 2212 RRD Measurement Archive (Java) - (Effort ~15 hr)
- 2213 SQL Measurement Archive - (Effort ~2 hr)
- 2214 Lookup Service - (Effort ~15 hr)
- 2215 SSHTelnet Measurement Point - (Effort ~20 hr)
- 2216 Command Line Measurement Point - (Effort ~20 hr)
- 2217 BWCTL Measurement Point (Perl)
-
- 222 Automatic Installation of pre-requisites
-
- 2221 RRD Measurement Archive (Java)
- 2222 SQL Measurement Archive
- 2223 Lookup Service
- 2224 SSHTelnet Measurement Point
- 2225 Command Line Measurement Point
- 2226 BWCTL Measurement Point
-
- 23 Using the perfSONAR 20 Bundle Installer
- 24 Interactive Questions
-
- 241 RRD Measurement Archive (Java)
-
- 2411 Pre-installation
- 2412 Configuration
- 2413 Deployment
-
- 242 SQL Measurement Archive
-
- 2421 Pre-install step
- 2422 Configuration
- 2423 Deployment
-
- 243 Lookup Service
-
- 2431 Pre-installation
- 2432 Configuration
- 2433 Deployment
-
- 244 SSHTelnet Measurement Point
-
- 2441 Pre-installation
- 2442 Configuration
- 2443 Deployment
-
- 245 Command Line Measurement Point
-
- 2451 Pre-installation
- 2452 Deployment
-
- 246 BWCTL Measurement Point
-
- 2461 Pre-installation
- 2462 Configuration
- 2463 Deployment
- 2464 Testing
-
- 25 Advanced Installation
-
- 251 With the help of the bundle installer
- 252 With the help of ant or perl scripts which are part of each service
- 253 Re-configuration
-
- 3 Stitching
-
- 31 What is Stitching
- 32 RRD MA Stitching
- 33 SQL MA Stitching (utilisation and lightpath status)
- 34 SSH Telnet MP Stitching
-
- 4 Backing up your configurations
- 5 Upgrading your existing RRD MA and SQL MA metadata configurations
- 6 Upgrading existing (lt20) perfSONAR software
- 7 Uninstallation
-
- 71 Uninstalling perfSONAR 10 bundle
- 72 Uninstalling older versions (lt20 but gt10) of perfSONAR services
- 73 Uninstalling services bundled in 20
-
- 731 Uninstalling JAVA Services
- 732 Uninstalling Perl Services
-
- 74 Uninstalling perfSONAR 20 bundle
-