http://archive.groundworkopensource.com/groundwork-opensource/trunk/build/INSTALLATION_INSTRUCTIONS Date: 2006-08-11 10:09:57 -0700 (Fri, 11 Aug 2006) GroundWork Monitor 5.0-alpha Copyright 2007 GroundWork Open Source, Inc. (“GroundWork”) All rights reserved. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 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 Street, Fifth Floor, Boston, MA 02110-1301, USA. INSTALLATION INSTRUCTIONS ------------------------- Installation of GroundWork Monitor Open Source 5.0-alpha from an RPM or Package requires preparing the installation environment, installing prerequisite software components, and following the installation procedure. At present, the instructions describe the RedHat Enterprise Linux 4 environment. We will add instructions for new environments as the project continues toward a stable release. Here is how things are organized: 1 SUPPORTED OPERATING SYSTEMS 2 SOFTWARE PREREQUISITES 3 BROWSER RECOMMENDATIONS 4 HARDWARE RECOMMENDATIONS 5 INSTALLATION PREREQUISITES 6 STEPS FOR A NEW INSTALLATION 7 STEPS FOR AN UPGRADE INSTALLATION 8 KNOWN ISSUES 1 SUPPORTED OPERATING SYSTEMS ------------------------------ The GroundWork Monitor Open Source 5.0-alpha RPM-based installer enables all components to be installed together on standard versions of commercial Linux. These supported operating systems are recommended for stability and performance reasons. * Red Hat Linux Enterprise WS 4 - Perform a default install but you may want to remove Office and Graphics tools. - Red Hat 4 includes, as a default, MySQL 4.1.10a which should be un-installed. The Red Hat default MySQL version is not supported so it must be un-installed and MySQL version 5.0.16 or higher installed. 2 SOFTWARE PREREQUISITES ------------------------ * MySQL version 5.0.16 or higher * Linux Kernel version 2.6 * glibc lib version 2.3 3 BROWSER RECOMMENDATIONS -------------------------- GroundWork recommends the following web browsers when using GroundWork Monitor Professional: * Firefox 1.x * Internet Explorer 6.x 4 HARDWARE RECOMMENDATIONS -------------------------- The minimum hardware configuration for a single GroundWork Monitor server is as listed below. Assuming that the system is configured to monitor 100 Hosts that are polled at default intervals, and that standard Service Profiles are used, the minimum configuration will suffice. In extreme cases, more powerful hardware (increased CPU speed and quantity, and RAM) can be used to extend the system. At this time there is no support for 64-bit Linux kernels. * Minimum Hardware Configuration - Intel Pentium 4 CPU 1 GHz - 1 GB RAM - 40 GB hard disk - CD ROM drive * Recommended Hardware Configuration - Intel Pentium 4 CPU 2 GHz or above - 4 GB RAM - 80 GB hard disk - CD ROM drive 5 INSTALLATION Pre Requisites ----------------------------- * SE Linux Configuration The SE Linux package interferes with MySQL installation and must be disabled. It can be re-enabled after installing MySQL. 1) Edit the /etc/selinux/config file so that it looks like: # This file controls the state of SELinux on the system. # SELINUX= can take one of these three values: # enforcing - SELinux security policy is enforced. # permissive - SELinux prints warnings instead of enforcing. # disabled - SELinux is fully disabled. SELINUX=disabled # SELINUXTYPE= type of policy in use. Possible values are: # targeted - Only targeted network daemons are protected. # strict - Full SELinux protection. #SELINUXTYPE=targeted 2) If you change these settings you may need to re-boot your system before installing MySQL. * The version of Perl-DBI-1.40-5.i386.rpm needs to be installed on Red Hat servers prior to MySQL. * MySQL Configuration 1) Package Install GroundWork Monitor Open Source requires the following packages (version 5.0.16 or higher) to be installed on the system. - MySQL-server - MySQL-client - MySQL-shared-compat If you are not sure if the correct version of the packages are installed, query the RPM database for each package using % rpm -qa |grep MySQL. You can install these packages by copying the appropriate MySQL rpm files for your operating system and issuing the command: % rpm -Uvh MySQL*. This will install the MySQL packages in the correct order. 2) Database Access The installer needs root access for creating new databases and setting the permissions. If your root password for MySQL is empty (not recommended but the default after installing MySQL) no further MySQL configuration is needed and you can proceed with the installation step. If a root password had been specified you can pass it to the installer by setting an environment variable. IMPORTANT NOTE The root password is only needed for installation. None of the GroundWork Monitor Professional applications require root access to MySQL. The database credentials are stored in /usr/local/groundwork/config/db.properties. 1) Create an environment variable MYSQL_ROOT (all uppercase) with the password value (i.e. export MYSQL_ROOT=password). 2) Perform the installation as described below. 3) Exit the shell so that the variable is no longer visible. * Network Configuration MySQL uses the name localhost from the file /etc/hosts. Make sure that the localhost entry looks like the example below. Also, make sure that localhost is first after the IP address followed by localhost.localdomain. Replace 192.168.2.100 with the IP address of the system, and groundworkserver with the real Host name. 127.0.0.1 localhost localhost.localdomain 192.168.2.100 groundworkserver groundworkserver.mydomain.com Also make sure TCP port 3306 is not blocked by your firewall rules. This port is for communication to MySQL server. 6 STEPS FOR A NEW INSTALLATION ------------------------------ The following installation instructions are updated for the current release of GroundWork Monitor Open Source 5.0-alpha. This install package provides all GroundWork components in a single RPM. * To performing the installation you have to be root on the system. * This installation places all files in the directory /usr/local/groundwork. GroundWork's version of Apache is installed with this package. If you are running Apache on your system, it will be stopped during the installation process, but not removed. Any content served will be served by the GroundWork version of Apache, but you should be aware that patches applied using the usual patch distribution systems will not be applied to the running version of Apache. The GroundWork Monitor Professional package should be installed on a standalone system to avoid this scenario. * To install the package, copy the file groundwork-monitor-osv-5.0.0-xx.i386.rpm to your system by entering the command: # rpm -Uvh groundwork-monitor-os-5.0.0-xx.i386.rpm. IMPORTANT NOTE: The install from rpm -Uvh automatically places a default nagios.cfg in the config directory (overwriting whatever was there) and starts it. This means you lose several files, namely status.log and status.sav, RRD's, nagios.log, and apache error and access logs. You should perform a backup. It is good practice to do this whenever performing an installation. The minimum you want to keep in this case includes: /usr/local/groundwork/nagios/etc /usr/local/groundwork/nagios/var /usr/local/groundwork/nagios/eventhandlers /usr/local/groundwork/nagios/libexec /usr/local/groundwork/apache2/log /usr/local/groundwork/apache2/cgi-bin /usr/local/groundwork/rrd After removing groundwork-monitor, a directory has been created called /usr/local/groundwork/backup that contains backup tar-gzip files: apache2-cgi.bin-backup.tar.gz apache2-log-backup.tar.gz etc-backup.tar.gz monarch-backup.tar.gz nagios-etc-backup.tar.gz nagios-eventhandlers-backup.tar.gz nagios-libexec-backup.tar.gz rrd-backup.tar.gz * If you need to un-install the package, enter the command: # rpm -e groundwork-monitor-os-5.0.0 To check which version you have installed, enter the command # rpm -qa | grep groundwork-monitor IMPORTANT NOTE: rpm -e removes all traces of GroundWork Monitor, including any config files. You should back up all the RRDs, config files, and log files at a minimum if you want to keep these around. It is good practice to do this whenever performing a software install. * Check the output for error messages. * To access GroundWork Monitor Open Source, go to the URL http:///. The default administrator user ID and password is admin/admin. Use this ID to define users, roles, packages, configure packages and assign packages to roles. The administrator role also provides access to the Monarch configuration system, which allows you to configure the Nagios monitoring system. An Operator role is already defined. The default user ID and password is joe/joe. This role will allow you to access GroundWork Monitor Open Source Status, Reports and Bookshelf applications. * Nagios files are installed in the following directories: - Binaries: /usr/local/groundwork/nagios/bin - Configuration: /usr/local/groundwork/nagios/etc - Eventhandlers: /usr/local/groundwork/nagios/eventhandlers - Plugins: /usr/local/groundwork/nagios/libexec - Share: /usr/local/groundwork/nagios/share - Logs: /usr/local/groundwork/nagios/var - Command: /usr/local/groundwork/nagios/var/spool - CGIs: /usr/local/groundwork/apache2/cgi-bin 7 STEPS FOR AN UPGRADE INSTALLATION ----------------------------------- Upgrade from prior versions is not supported at this time. 8 KNOWN ISSUES --------------- Please refer to the README file for known issues. The README file is in the open source repository at this URL: http://archive.groundworkopensource.com/groundwork-opensource/build/README