/ 
XAS-Collector-0.03
River stage zero No dependents
/ XAS::Docs::Collector::Installation

NAME

XAS::Docs::Collector::Installation - how to install the XAS Collector

XAS is middleware for datacenter operations. It provides standardized methods, modules and philosophy for constructing applications typically used to manage a datacenter. This system is based on production level code.

GETTING THE CODE

Since the code repository is git based, you can use the following commands:

# mkdir XAS-Collector
# cd XAS-Collector
# git init
# git pull http://scm.kesteb.us/git/XAS-Collector master

Or you can download the code from CPAN in the following manner:

# cpan -g XAS-Collector
# tar -xvf XAS-Collector-0.01.tar.gz
# cd XAS-Collector-0.01

When done, the following commands are run from that directory.

INSTALLATION

On Unix like systems, using pure Perl, run the following commands:

# perl Build.PL --installdirs site
# ./Build
# ./Build test
# ./Build install
# ./Build post_install

If you are DEB based, Debian build files have been provided. If you have a Debian build environment, then you can do the following:

# debian/rules build
# debian/rules clean
# dpkg -i ../libxas-collector-perl_0.01-1_all.deb

If you are RPM based, a spec file has been included. If you have a rpm build environment, then you can do the following:

# perl Build.PL
# ./Build --installdirs vendor
# ./Build test
# ./Build dist
# rpmbuild -ta XAS-Collector-0.01.tar.gz
# cd ~/rpmbuild/RPMS/noarch
# yum --nogpgcheck localinstall perl-XAS-Collector-0.01-1.noarch.rpm

Each of these installation methods will overlay the local file system and tries to follow Debian standards for file layout and package installation.

On Windows, do the following:

> perl Build.PL
> Build
> Build test
> Build install
> Build post_install

It is recommended that you use Strawberry Perl, ActiveState Perl doesn't have all of the necessary modules available.

WARNING

Not all of the Perl modules have been included to make the software 
run. You may need to load additional CPAN modules. How you do this,
is dependent on how you manage your systems. This software requires 
Perl 5.8.8 or higher to operate.

DATABASE CREATION

If you are planning to use a database as your datastore. The following will create a SQLite3 database.

On Unix/Linux do the following:

 # xas-create-schema --schema XAS::Model::Database::Messaging --directory .
 # sqlite3 /var/lib/xas/messaging.db < ./XAS-Model-Schema-0.01-SQLite.sql
 # rm -f ./XAS-Model-Schema-0.01-SQLite.sql

On Windows do the following:

> xas-create-schema --schema XAS::Model::Database::Messaging --directory .
> sqlite3 \XAS\lib\messaging.db < XAS-Model-Schema-0.01-SQLite.sql
> delete XAS-Model-Schema-0.01-SQLite.sql

POST INSTALLATION

You should check the collectors configuration file to see if the proper modules are being loaded. By default, it only loads the modules needed to handle Alerts and Log message types and those modules will either need a database or a logstash instance to work correctly. Setting up either one is beyond the scope of this document.

Once that is done. You need to start the collector. On Debian or RHEL you would issue the following commands:

# service xas-collector start
# chkconfig --add xas-collector

On Windows, use these commands:

> xas-collector --install
> sc start XAS_COLLECTOR

Now you can check the log files for any errors and proceed from there.

SUPPORT AND DOCUMENTATION

After installing, you can find documentation for this module with the perldoc command.

perldoc XAS-Collector

Extended documentation is available here:

http://scm.kesteb.us/trac

The latest and greatest is always available at:

http://scm.kesteb.us/git/XAS-Collector

LICENSE AND COPYRIGHT

Copyright (c) 2015 Kevin L. Esteb

This is free software; you can redistribute it and/or modify it under the terms of the Artistic License 2.0. For details, see the full text of the license at http://www.perlfoundation.org/artistic_license_2_0.