Collage - The ultimate data integration framework. Copyright (C) 2004-2006 GroundWork Open Source Solutions info@groundworkopensource.com This program is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Last Update Friday February 10, 2006 Installation and Build instructions for Collage ----------------------------------------------------------- Pre-requisites ------------------ Collage is written in Java and therefore platform independent. Make sure that the Java SDK 1.4.2 or Java SDK 1.5 is installed and configured. The current version requires MySQL 4.1.8 or higher. Please install server, client and compat components. Build preparation ----------------------- The collage components are written in Java and therefore the Java SDK 1.4.2 or Java SDK 1.5 needs to be installed and configured on the build machine. The Collage build is based on ant 1.6.x (http://ant.apache.org/) and maven 1.0.x (http://maven.apache.org/) need to be installed on the local machine Please download and install the tools. Make sure that ANT_HOME and MAVEN_HOME are defined and the bin directories are in the path. Prepare ---------- untar the package Build -------- Build with maven ----------------------- Edit project.properties and set the following properties: org.groundwork.foundation.deploy.root Directory were the collage components are installed org.groundwork.deploy.lib directory for the jar files gets appended to deploy directory org.groundwork.deploy.bin directory for scripts gets appended to deploy directory org.groundwork.deploy.conf directory for database configuration gets appended to deploy directory The following properties define the database connection. After the build the db.properties is copied into the conf directory defined above: com.groundwork.collage.production.database.url = JDBC string for server and database name com.groundwork.collage.production.database.user = user name com.groundwork.collage.production.database.password = password Collage uses log4j for login the following property defines the log directory: com.groundwork.collage.log.dir Full path to log directory The Nagios feeder need to be configured so that it finds the Nagios status and log files: org.groundwork.nagios.var Nagios var file Default: /usr/local/nagios/var org.groundwork.nagios.log Nagios log directory Default: /usr/local/log org.groundwork.nagios.nagios Nagios Log file Default /usr/local/nagios/var/nagios.log org.groundwork.nagios.config Nagios config file Default /usr/local/etc/nagios/nagios.cfg Once all the above properties are set launch the maven command from the command line as following: maven allBuild This builds are jar files (Feeder, Listener and API's) and copies them into directories defined in the project.properties file. Build and install are two separate commands. For building the components type : maven build For installation type: maven install Build with configure -------------------------- Run ./configure --help to view available parameters. The configure process is a wrapper around the above procedures. This is included for compatibility for GNU based systems. A simple ./configure && make && make install will perform a basic installation. Database ------------- There is a maven task to load the database. Before invoking the command create the database GWCollageDB and give permissions to the user as defined in the properties file. Execute from the command line: maven db.create.production This will create all tables and populate the auxiliary tables with pre-defined values for Status, Severity , etc. Loading the database from the command line execute: mysql -uUSER -pPWD GWCollageDB < collage/database/schema/GWCollageDB.sql Seed data: Load all the files from the database/seed directory into GWCollageDB Make sure the database credentials match with the values in the db.properties file in the deploy conf directory. Configuration of Nagios Feeders ------------------------------------------- The feeder scripts are generated reading the nagios properties during the build. All feeder scripts end up in the deploy bin directory. Starting Listener/Feeder -------------------------------- Deploy bin directory launch the script: collaged-db-service.sh. It launches a java process and is waiting for feeder requests. Launch the feeders: nagios2collage_socket.pl and nagios2collage_eventlog.pl Collage API --------------- The API's are copied into the deploy lib JAVA API: deploy-dir/lib Perl API: deploy-dir/lib/perl PHP API: deploy-dir/lib/php Questions/suggestions ----------------------------- use the mailing list gwfoundation-devel on sourceforge.net for any discussions and feature requests. To subscribe: http://sourceforge.net/mail/?group_id=144944