From: announce-admin@opennms.org To: "Announce List" <announce@opennms.org> Subject: [OpenNMS-Announce] OpenNMS Quick Start Guide (DRAFT) Date: Fri, 24 Aug 2001 12:26:16 -0000 Shane O. ======== Shane O'Donnell OpenNMS.org shaneo@opennms.org ================== OpenNMS Quick Start Guide OpenNMS.org Published in 2001. Revision: 2.0. Copyright (c) 1999, 2000, 2001, PlatformWorks, Inc . www.opennms.org _________________________________________________________________ Introduction Table of Contents P Acknowledgments, Copyrights and Introduction P.1 Introduction 1 Minimum Requirements 1.1 Minimum Requirements 2 Configuring Dependencies 2.1 Uninstalling Preconfigured Software 2.2 JAVA 3 Installation 3.1 Directory Structure 3.2 Installing OpenNMS from the Web Installer 4 Configuring OpenNMS 4.1 Adding Addresses 5 Viewing the Network 5.1 Starting OpenNMS 5.2 Viewing the Network _________________________________________________________________ P Preface Acknowledgments, Copyrights and Introduction Copyrights Copyright (C) 1999-2001 PlatformWorks, Inc. All rights reserved. Copyright (c) 1996-2001 PostgresSQL, Inc. Copyright (c) 1994 Regents of California, Inc. Copyright (c) 1994-2001 Sun Microsystems, Inc Copyright (c) 1994-2001 IBM Corporation Copyright (c) 2001 Microsoft Corporation Copyright (c) 2001 Netscape Copyright (c) 2001 Red Hat, Inc. Copyright (c) 1999-2001 ExoLab Group Copyright (c) 1999-2001 Apache Software Foundation Copyright (c) 1998-2001 The Mozilla Organization Useful links for information XSLFO Spec, Oct 2000 XSLFO Bible XSL Info Site XML Organization Docbook Organization O'Reilly's DocBook: The Definitive Guide OpenNMS.org - OpenNMS web site apache.org - home of Xerces, XML4J etc Sun - home of JAVA W3C Organization - home of XSLFO and XML PostgreSQL - home of PostgreSQL P.1 Introduction The Quick start process takes the administrator through a minimal installation. Some administrators may wish to refer to the more comprehensive set-up information available in the Installation Guide. _________________________________________________________________ 1 Chapter 1 Minimum Requirements 1.1 Minimum Requirements For purposes of this guide, requirements are very specific. While actual requirements may vary, this document's purpose is to guide a user installing and configuring quickly. Resource Minimum Requirement Available Resources OpenNMS Installation Media/File Version 8.1 or greater www.OpenNMS.org Linux Op System Redhat 7.0, or 7.1 www.redhat.com JAVA Virtual Machine (JVM) Version 1.3 or greater www6.software.ibm.com/dl/dklx130/dklx130-p Free Disk Space 25Mb (+8Mb/SNMP Device) in /opt, 25Mb in /tmp Free Memory 256 MB available _________________________________________________________________ 2 Chapter 2 Configuring Dependencies For purposes of this quick start guide, it is assumed that the web installer will be installing and configuring most of your dependencies. you will need to make sure that some packages are not installed prior to begining the web installer, in order to insure correct configuration. 2.1 Uninstalling Preconfigured Software If you would like to install and configure dependency software on your machine please use the OpenNMS Installation Guide. Otherwise we will begin by uninstalling already installed software that may not be configured to run with OpenNMS. The packages we need to insure are not already installed are listed below, along with a command line to test wether or not the RPMs are currently installed. PostgreSQL # rpm -qa | grep -i postgres OpenJMS # rpm -qa | grep -i openjms Tomcat # rpm -qa | grep -i tomcat RRDTool # rpm -qa | grep -i rrdtool OpenNMS # rpm -qa | grep -i opennms If you find one of these packages is installed, you will need to uninstall it. # rpm -qa | grep -i postgres postgresql-devel-7.0.3-8 postgresql-server-7.0.3-8 postgresql-7.0.3-8 # rpm -e postgresql-devel-7.0.3-8 postgresql-server-7.0.3-8 postgresql- 7.0.3-8 2.2 JAVA The JDK package is necessary for building from source. If you are installing a binary distribution of the OpenNMS software you will only need the runtime environment.(JRE) In either case the environment variable JAVA_HOME should be set to /opt/IBMJava2-13 or the directory where it was installed. _________________________________________________________________ 3 Chapter 3 Installation 3.1 Directory Structure When installed, OpenNMS defaults to the following directories: Location Directory OpenNMS Binaries /opt/OpenNMS/ OpenNMS Config Files /opt/OpenNMS/data/common/conf/ SQL Libraries /usr/lib/pgsql/opennms/ Boot script /etc/rc.d/init.d/opennms Database Store /var/ 3.2 Installing OpenNMS from the Web Installer To install or upgrade on a supported RPM platform, run, as root: lynx -source http://install.opennms.org | sh NOTE: It has been noticed that in some cases, the install script will "hang" after it has completed installing the OpenNMS RPMs. The only thing left to be done at this point is to install the documentation. If you notice this condition during your install you can safely use <ctrl>C to break out of the script. At that point you can either run the script again, and the documentation will be installed, or simply verify that OpenNMS was installed by typing ... rpm -qa | grep -i opennms _________________________________________________________________ 4 Chapter 4 Configuring OpenNMS 4.1 Adding Addresses Each package defines address(es) to be polled and service(s) to be monitored. Package(s) can then be added to a poller. The first task is assigning address to be polled. This can be done by adding an include range to the package. Within the ranges section of the package "example1" add the range of addresses to include. The following is a snippet from packages.xml. In this example we include the network 192.168.0.0/24 and override the default values for retries and timeouts. <irange> <parms> <parm> <parmName>retries</parmName> <value>1</value> </parm> <parm> <parmName>end</parmName> <value>192.168.0.254</value> </parm> <parm> <parmName>begin</parmName> <value>192.168.0.1</value> </parm> <parm> <parmName>timeout</parmName> <value>5s</value> </parm> </parms> </irange> _________________________________________________________________ 5 Chapter 5 Viewing the Network 5.1 Starting OpenNMS Make sure you remembered to start the necessary dependencies. /sbin/service start portmap /sbin/service start postgresql /sbin/service start openjms After those dependencies are started, you can start OpenNMS /sbin/service opennms start or /opt/OpenNMS/opennms.sh all start OpenNMS should start the tomcat server as well. At this point you can grab a cup of coffee. Once everything is started, the web ui should be available. However the discovery process is on a 5 minute delay. You can check the status of OpenNMS and "service control manager" using the following command. # /opt/OpenNMS/opennms.sh scm status ----------------------------------------------------------------------- ------- OpenNMS Command (Revision: functions.sh,v 1.15 2001/07/06 19:30:25 ben Exp $) ----------------------------------------------------------------------- ------- OpenNMS.eventd : RUNNING OpenNMS.trapd : RUNNING OpenNMS.actiond : RUNNING OpenNMS.dhcpd : RUNNING OpenNMS.icmpd : RUNNING OpenNMS.capsd : RUNNING OpenNMS.OutageManager : RUNNING OpenNMS.RTCViewCategoryManager : RUNNING OpenNMS.discovery : RUNNING OpenNMS.scheduler.ICMP : RUNNING OpenNMS.scheduler.SNMP : RUNNING OpenNMS.scheduler.HTTP : RUNNING OpenNMS.scheduler.FTP : RUNNING OpenNMS.scheduler.SMTP : RUNNING OpenNMS.scheduler.DNS : RUNNING OpenNMS.scheduler.OpenSSH : RUNNING OpenNMS.scheduler.Postgres : RUNNING OpenNMS.scheduler.MySQL : RUNNING OpenNMS.scheduler.SQLServer : RUNNING OpenNMS.scheduler.Informix : RUNNING OpenNMS.scheduler.Sybase : RUNNING OpenNMS.scheduler.Oracle : RUNNING OpenNMS.scheduler.DHCP : RUNNING OpenNMS.scheduler.IMAP : RUNNING OpenNMS.scheduler.POP3 : RUNNING If there are any problems or services are not starting correctly, you can check the logs for more information. The log files are located in /var/log/opennms/ 5.2 Viewing the Network Once tomcat is started, you can, in your web browser go to the following address. http://127.0.0.1:8080/opennms/ login: admin/admin After logging in you will be directed to the main OpenNMS view of your network. Although most browsers will work, only the following are officially supported... for Linux: Netscape 4.7+, Netscape 6+, Mozilla 0.8+ and for Windows: Netscape 4.7+, Netscape 6+, IE 5.5+