lookup service

generic installation instructions

The perfSONAR-PS Lookup Service (LS) functions as a directory of information gathered from other perfSONAR services in a domain. Every perfSONAR-PS service is capable of registering location and metadata information with the LS. The LS then stores, summarizes, and shares this information with the global Information Services (IS) framework. This information may then be searched for in numerous ways, making it easier to locate resourses without asking services for information directly.

The LS relies on an XML database (e.g. the Oracle DBXML) to store information. The package notes this dependency and makes every effort to streamline the installation process.

prerequisites

The LS is packaged as an RPM - an installation format geared towards use on Red Hat linux based systems. Examples include Fedora, Red Hat Enterprise Linux, CentOS, White Box, Scientific Linux, and possibly others.

These Linux distributions normally rely on "Package Management" tools to install and maintain software. Examples of these tools include up2date, YUM, and APT-RPM. Internet2 has created a repository to house the perfSONAR-PS software, related performance tools, and hard to find prerequisites. We encourage adopters of these performance tools to install a simple RPM package that gives the necessary configuration information for the YUM and APT-RPM tools. The RPM can be found here:

wget -c http://software.internet2.edu/rpms/i386/main/RPMS/Internet2-repo-0.2-5.noarch.rpm

To install this RPM first import the signing key:

rpm --import http://software.internet2.edu/rpms/RPM-GPG-KEY-Internet2

Then install the RPM:

rpm -ivh Internet2-repo-0.2-5.noarch.rpm

It is also recommended that an additional repository be installed for hard to find prerequisite software that may not be available in traditional repositories used by the Linux distributions. Two regarded repositories are:

http://dries.ulyssis.org/rpm/
http://dag.wieers.com/rpm/

Each site provides configuration instructions and packages similar to the Internet2 repository.

If using a package management system is not an option, or if your system is not RedHat based (e.g. Debian, Gentoo, etc.) it is still possible to install this software and related requirements by hand. Please see the "Installation (Tar Package)" and "Installation (SVN)" sections for more details. This tool uses the following Perl libraries, libraries, and external tools to function:
  • Perl Libraries
    • Config::General
    • Cwd
    • Data::UUID
    • Data::Validate::IP
    • Digest::MD5
    • English
    • Error
    • Exporter
    • File::Basename
    • File::Temp
    • File::stat
    • Getopt::Long
    • HTTP::Daemon
    • Hash::Merge
    • IO::File
    • LWP::Simple
    • LWP::UserAgent
    • Log::Dispatch
    • Log::Dispatch::FileRotate
    • Log::Log4perl
    • Module::Load
    • Net::CIDR
    • Net::IPTrie
    • Net::IPv6Addr
    • Net::Ping
    • Params::Validate
    • Sleepycat::DbXml
    • Sys::Hostname
    • Time::HiRes
    • XML::LibXML
  • Libraries
    • LibXML2
  • Tools
    • Oracle DB XML
NOTE: For all following installation methods, the installation instructions require that you know the RELEASE NUMBER; it must be inserted where the text says releasenumber. An example would be "3.1-1".

Installation (YUM)

Installation using YUM lets the package manager do the work of finding and installing the dependencies. The following command is all that is needed:

yum install perl-perfSONAR_PS-LookupService-releasenumber.pSPS.noarch.rpm

There may be several prerequisites to install depending on the age of your system. To ensure that all are found, please be sure to install one of the alternative repositories above.

installation (APT-RPM)

Like YUM, installation with APT-RPM also manages the task of finding dependencies. The following commands will install is needed:

apt-get update apt-get install perl-perfSONAR_PS-LookupService-releasenumber.pSPS.noarch.rpm

There may be several prerequisites to install depending on the age of your system. To ensure that all are found, please be sure to install one of the alternative repositories above.

installation (Bare RPM)

If you do not wish to install the Internet2 Repository package, you may simply find the appropriate RPM for your architecture without using a package manger. For example if you are on an "i386" architecture:

wget -c http://software.internet2.edu/rpms/i386/main/RPMS/perl-perfSONAR_PS-LookupService-releasenumber.pSPS.noarch.rpm

To install without package manager help:

rpm -ivh perl-perfSONAR_PS-LookupService-releasenumber.pSPS.noarch.rpm

Note that this RPM may need other packages to install correctly: if these packages are not found on your system, you will need to manually download and install them before proceeding. An alternate method is to still use a package manager in a "local" way (YUM only):

yum localinstall perl-perfSONAR_PS-LookupService-releasenumber.pSPS.noarch.rpm

This will search the available repositories for any necessary packages.

installation (Tar Package)

All RPM packages are also available in "source" packages that may be installed and used in the typical Unix/Linux fashion. There are helper scripts included that may be used to download the necessary prerequisite software packages:

wget -c http://software.internet2.edu/source/perfSONAR-PS/perfSONAR_PS-LookupService-releasenumber.tar.gz
tar -zxfv perfSONAR_PS-LookupService-releasenumber.tar.gz
cd perfSONAR_PS-LookupService-releasenumber
make install
cd scripts
./install_dependencies.sh
./prepare_environment.sh

The last three steps need to be run as root or via sudo. The latter two steps will configure the machine's users and startup scripts as well as contact CPAN for any necessary perl libraries.

In addition to perl requirements, there are other software requirements that should be installed. These are not controlled via the dependency scripts due to differences in package mangement. The tools are listed below:

  • Oracle DB XML
  • LibXML2
    • Package management names:
      • Debian/Ubuntu: libxml2, libxml2-dev, libxml2-utils
      • RedHat Systems: libxml2, libxml2-devel

installation (SVN)

Software may be downloaded directly from our anonymous subversion server. This installation method allows for easy upgrades between versions and access to bugfixes immediately. There are two ways to download from our server, one that retrieves all software and another that retrieves only selective services.

To download the entire release:

svn checkout http://anonsvn.internet2.edu/svn/perfSONAR-PS/tags/RELEASE_3.1 perfSONAR-PS

The instructions are the same here as for the Tar package. Note that installation may require pre-requisite software. Read the preceding sections for necessary items and suggestions on how to install and configure them. When you wish to update the checkout (to retrieve new development or bugfixes):

cd perfSONAR-PS
svn update

If a single service is all that is required, a similar method is used but also note that the service must have access to a "Shared" directory that contains perfSONAR-PS libraries:

svn checkout http://anonsvn.internet2.edu/svn/perfSONAR-PS/tags/RELEASE_3.1/perfSONAR_PS-LookupService/
svn checkout http://anonsvn.internet2.edu/svn/perfSONAR-PS/tags/RELEASE_3.1/Shared

The instructions are also the same as above:

cd Shared
svn update

and

cd perfSONAR_PS-LookupService
svn update