You are on page 1of 16

RiverMuse ECM

Installation Guide

May 2011
Revised: 5/19/2011 1:02 AM

www.rivermuse.com
Copyright Notice
© 2011 RiverMuse. All rights reserved.
This manual and the accompanying software it describes are copyrighted
with all rights reserved. Under U.S. and international copyright laws, neither
this manual nor the software may be copied or reproduced, in whole or in
part, in any form, and no part of this manual or the software may be stored
in a retrieval system, electronic or mechanical, without the written consent
of RiverMuse, except in the normal use of the software or to make a backup
copy.

Trademarks
RiverMuse brand and product names are trademarks or registered
trademarks of RiverMuse in the U.S. and other countries. You may not use or
display these marks without the explicit advance written consent of
RiverMuse.

RiverMuse
USA
805 Veterans Blvd., Suite 309
Redwood City, CA 94063

UK
Friars House 157-168 Blackfriars Road
London, SE1 8EZ UK
+44 (0)20 7633 9806

www.RiverMuse.com

Part Number: instdoc-05-2011


Contents

Installing RiverMuse ECM ......................................................................... 5


Overview ......................................................................................................................................... 5
Prerequisites ................................................................................................................................... 5
Hardware Requirements ......................................................................................................... 5
Software Requirements ........................................................................................................... 5
Installing RiverMuse ECM ............................................................................................................ 6
Installing and Configuring MySQL and RiverMuse ECM ..................................................... 6
Installing and Configuring rsyslog ........................................................................................ 10
Configuring rsyslog ...........................................................................................................11
Installing and Configuring snmptrapd .................................................................................. 11
Editing snmptrapd.conf .................................................................................................. 12
Configuring Connectors ............................................................................................................... 12
Configuring JIRA ................................................................................................................... 12
Configuring Service-now ....................................................................................................... 13
Configuring SolarWinds ........................................................................................................ 13
Troubleshooting ........................................................................................................................... 14
Addendum A: Configuring Sun JRE 6 ........................................................................................ 14
Determining Whether Sun JRE 6 is Already Configured Correctly ................................... 14
Installing Sun JRE 6 .............................................................................................................. 15
Installing Sun JRE 6 Using yum ..................................................................................... 15
Installing Sun JRE 6 Manually ....................................................................................... 15

RiverMuse ECM Installation Guide iii


Contents

iv RiverMuse ECM Installation Guide


Installing RiverMuse ECM

Overview
Thank you for your interest in the RiverMuse ECM! RiverMuse ECM is a real-time, cross-
domain event correlation software application that enables enterprises to optimize IT
Operations processes so they can drive down costs, resolve problems faster and assure end
user services. It achieves this by automating the event to alert to incident life cycle and
bridging the gap between IT Operations center and the Service Desk – driving higher
productivity and effectiveness.

Prerequisites
Before attempting to install and configure RiverMuse ECM, ensure that you satisfy the
following hardware, software, and security requirements:

Hardware Requirements
 A server with dual quad-core processors and 8GB of RAM

Software Requirements
 Red Hat Enterprise Linux 5

 MySQL 5.0 or 5.1

 Sun JRE 6*
* Refer to Addendum A: Configuring Sun JRE 6 if you need assistance configuring this
prerequisite.

 The RiverMuse SolarWinds connector supports Orion NPM 10.0 or later

 Ensure that your firewall is open for Tomcat (TCP port 8080). This setting is typically in
the /etc/sysconfig/iptables file.
 The JDBC connector only supports MySQL databases.

 RiverMuse ECM supports the following LDAP data stores:

• OpenLDAP
• Microsoft Active Directory

RiverMuse ECM Installation Guide 5


Installing RiverMuse ECM

Installing RiverMuse ECM


The following subsections describe how to install and configure RiverMuse ECM.

Installing and Configuring MySQL and RiverMuse ECM


To install RiverMuse ECM:
1. Download the RiverMuse ECM software and license key from the RiverMuse website.
2. Issue the following command from the same directory that contains the file
rivermuse.zip that you downloaded in the previous step:
unzip rivermuse.zip

This creates a directory named rivermuse.

3. Use the following command to create a database for RiverMuse ECM:

mysql -u root -e "create database dbname"

Replace dbname with a database name of your choice.

4. Use the following command to start Tomcat:

./rivermuse/bin/catalina.sh start

5. Launch the URL http://localhost:8080/rivermuse.

NOTE: The URL will be different if the system is being accessed remotely;
localhost will be the hostname or IP address of the machine containing the
RiverMuse ECM software.
The End User License Agreement screen appears:

6. Click the checkbox to accept the license terms and then click Next.
The Database Configuration screen appears:

6 RiverMuse ECM Installation Guide


Installing RiverMuse ECM

7. Enter the values for your database and then click Next. The database name will be the
name you provided in step 3 above.
The License Setup screen appears:

You use the License Setup screen, as described in the following steps, to locate the trial
license you downloaded earlier in step 1, and then to contact the RiverMuse Licensing
Service to validate the trial license.

8. Click the Browse button to locate the license key file you downloaded earlier in step 1.
9. If you do not need to use a proxy server, click Submit to contact the RiverMuse
Licensing Service.
If you do need to use a proxy server:

a. Click the proxy server checkbox.


The Proxy Server fields appear:

RiverMuse ECM Installation Guide 7


Installing RiverMuse ECM

b. Complete the Host and Port fields, and the Username and Password fields, if
required.
c. Click Submit.
The setup process begins and then the Authentication screen appears:

8 RiverMuse ECM Installation Guide


Installing RiverMuse ECM

10. Complete the administrator account fields.


11. Select an authentication method, complete any associated fields that appear on
subsequent screens based on your choice, and then click Submit. Mixed
Authentication means both Rivermuse authentication and LDAP authentication.
 If you select Rivermuse Authentication, then RiverMuse ECM stores all usernames
and passwords (encrypted) in the RiverMuse ECM database.
 If you select LDAP Only/Setup LDAP now or Mixed Authentication/Setup
LDAP now, then enter valid values for the LDAP fields. This version of RiverMuse ECM
supports OpenLDAP and Microsoft Active Directory only.
 If you select Setup LDAP Only/Setup LDAP later or Mixed
Authentication/Setup LDAP later, you can use the Configuration>Manage
Connectors tab, shown below, to setup LDAP later. See Configuring Connectors in
the Configuring the System section of the online help for more details.

After clicking Submit, the Dashboard appears:

RiverMuse ECM Installation Guide 9


Installing RiverMuse ECM

12. If you want to use Service-now, JIRA, or Solarwinds with RiverMuse ECM, then follow
the instructions in the next section, Configuring Connectors. If you do not plan to use
any of these connectors, then you have completed the RiverMuse ECM installation.

Installing and Configuring rsyslog


By default, RiverMuse ECM starts a syslog connector on UDP and TCP port 1514 (to avoid
conflicting with an existing syslog daemon) that is ready to accept forwarded syslog
messages immediately. RiverMuse recommends using rsyslog to forward syslog messages to
the RiverMuse syslog connector.

10 RiverMuse ECM Installation Guide


Installing RiverMuse ECM

rsyslog is not installed by default on RHEL. It can be installed using the following
commands:
sudo yum install rsyslog
sudo chkconfig syslog off
sudo chkconfig rsyslog on
sudo service syslog stop
sudo service rsyslog start

Configuring rsyslog
To configure rsyslog to forward messages to the RiverMuse syslog connector:
1. Add the following line to the end of the file /etc/rsyslog.conf (replacing localhost with
the hostname or IP of the RiverMuse ECM system):

*.* @localhost:1514

2. Restart rsyslog using the following command:

sudo service rsyslog restart

Installing and Configuring snmptrapd


This section describes how to install and configure net-snmp to use the RiverMuse perl API.
If you plan to receive snmptraps locally, open UDP port 162 on your firewall.
To install and configure snmptrapd:
1. Run the following command to enable the EPEL (extra repositories for Enterprise
Linux):
sudo rpm -Uvh http://download.fedora.redhat.com/pub/epel/5/i386/epel-release-5-
4.noarch.rpm

2. Run the following command to add the RiverMuse yum repository:

sudo wget -O /etc/yum.repos.d/rivermuse.repo


https://www.rivermuse.com/repository/rivermuse.repo

3. Run the following command to install the RiverMuse net-snmp trap handler:

sudo yum install net-snmp-rivermuse

4. If RiverMuse is not running on the same machine as snmptrapd (that is, not accessible at
http://localhost:8080/), then change the address to the correct host by editing
/etc/snmp/snmptrapd.conf as shown in Editing snmptrapd.conf below, and then
run the following command to restart snmptrapd for the changes to take effect:
sudo service snmptrapd restart

RiverMuse ECM Installation Guide 11


Configuring Connectors

Editing snmptrapd.conf
If RiverMuse is not running on the same machine as snmptrapd, you need to edit the file
snmptrapd.conf to point to the correct host. To edit snmptrapd.conf, open the file
/etc/snmp/snmptrapd.conf in an editor and change http://localhost:8080/,
highlighted below, to the correct host:
# BEGIN RIVERMUSE SNMPD_TRAPD_CONFIG
authCommunity log,execute,net public
# send traps on authentication failures
authtrapenable 1
# Don't log anything by default - just use the traphandlers
doNotLogTraps yes
#
# Enable the embedded trap handler.
# Forwards all traps directly to RiverMuse
#
perl $endpoint="http://localhost:8080/rivermuse/api/event";
perl do "/usr/local/sbin/embedded_trap_handler";
# END RIVERMUSE SNMPD_TRAPD_CONFIG

Configuring Connectors
This section describes how to configure JIRA, Service-now and Solarwinds for use with
RiverMuse ECM.

Configuring JIRA
The primary purpose of communicating with JIRA is to create an incident based on a
RiverMuse alert and to reflect the changes made on the incident to the alert.
To configure JIRA for use with RiverMuse ECM:
1. In the General Configuration page on the JIRA server (Administration > Global
settings > General Configuration), select Edit Configuration.
2. Turn on the option Accept remote API calls to allow the SOAP interface to function
correctly.
3. Click Update.
4. In the Projects page on the JIRA server (Administration > Projects), select Add
Project to add a new project.
5. Enter your new project details (Name, Key, Project Lead, Avatar, etc.).
6. Click Add.
7. Login to RiverMuse ECM, click the Configuration tab, and then configure a JIRA

12 RiverMuse ECM Installation Guide


Configuring Connectors

connector as described in the online help.

Note: Only one JIRA connector at a time can be configured and used in RiverMuse
ECM.

Configuring Service-now

The primary purpose of communicating with Service-now is to create an incident based on a


RiverMuse alert and to reflect the changes made on the incident to the alert.

To configure Service-now for use with RiverMuse ECM:


1. In the Service-now main page on the Service-now server, to allow the SOAP interface to
function correctly, select System Properties > Web Services.
2. Uncheck the last property (starting with “This property sets the elementFormDefault
attribute of the embedded XML schema to the value of unqualified, if set to true.”)
3. Click Save.
4. Login to RiverMuse ECM, click the Configuration tab, and then configure a Service-
now connector as described in the online help

Note: Only one Service-now connector at a time can be configured and used in
RiverMuse ECM.

Configuring SolarWinds
The firewall running on the SolarWinds machine needs to allow the RiverMuse ECM
machine to connect (ports 17777 and 17778).

You will complete different steps, depending on which SolarWinds software you are using.
Consult the following table for complete details:

If You Use this SolarWinds Software: Then Follow these Instructions:

Orion NPM 10.0 Complete all the instructions below, starting at step 1
and working through step 3.

Orion NPM 10.1 Complete only step 3 below.

To configure a SolarWinds connector:

1. Edit the following file on the SolarWinds server to enable remote connections to
SolarWinds using SWIS:
C:\Program Files (x86)\SolarWinds\Orion\Information
Service\2.0\SolarWindsInformationService.Service.exe.config,

a. Find this line (around line 33):

RiverMuse ECM Installation Guide 13


Troubleshooting

<add baseAddress=https://localhost:17778/solarWinds/InformationService />

b. Replace ‘localhost’ with the hostname or IP address of the Orion Server (no other line
or mention of ‘localhost’ needs to be replaced).
2. Restart the SolarWinds Information Service (SWInfoServiceSvc) on the SolarWinds
server by issuing the following commands from the command line:
sc stop SwInfoServiceSvc
sc start SwInfoServiceSvc

3. Login to RiverMuse ECM, click the Configuration tab, and then configure a
SolarWinds connector as described in the online help.

Note: The username you provide must be a local Orion user, not a Windows or MS AD
User.

Note: Only one SolarWinds connector per SolarWinds Orion NPM installation can be
configured for use in RiverMuse ECM.

Troubleshooting
The following table suggests some steps you can take to troubleshoot your RiverMuse ECM
installation.

Issue Suggested Actions

SolarWinds

Is the SolarWinds Information Open the WSDL at:


Service (SWInfoServiceSvc)
working properly? https://yourhost:17778/SolarWinds/InformationService?wsdl

The browser should prompt you to trust some certificates. If


the browser does not prompt you, then you need to restart the
SolarWinds Information Service as described in step 2 on
page 14.

Addendum A: Configuring Sun JRE 6


This section describes how to configure Sun JRE 6 for use with RiverMuse ECM.

Determining Whether Sun JRE 6 is Already Configured Correctly


To determine whether SUN JRE 6 is already correctly configured:
1. Run the following command from a command prompt:

java -version

14 RiverMuse ECM Installation Guide


Addendum A: Configuring Sun JRE 6

The command prints the current version to the screen, for example:

java version "1.6.0_24"


Java(TM) SE Runtime Environment (build 1.6.0_24-b07)
Java HotSpot(TM) 64-Bit Server VM (build 19.1-b02, mixed mode)
2. Check that the Java(TM) SE Runtime Environment version number, highlighted in
yellow above, for example, is build 1.6.0_xx-xxx. If the Java(TM) SE Runtime
Environment is not at this version, then follow the instructions below in the section,
Installing Sun JRE 6.

Installing Sun JRE 6


This manual provides instructions for installing Sun JRE 6 in two different ways: using yum
and manually. Refer to the following table for guidance on which method to use:

Operating System Installation Method


CentOS Manual
RedHat Enterprise Linux  yum (preferred method)
 Manual

Installing Sun JRE 6 Using yum


Installing using yum is the preferred method. This method only works on RedHat Enterprise
Linux systems. Additionally, the supplementary repository needs to be enabled on your
RedHat subscription.
To install using yum:
1. Install Sun JRE 6 by running the following command:

sudo yum install java-1.6.0-sun

2. Ensure Sun JRE 1.6.0 is the enabled as the default version of Java on the system by
running the following command:
sudo /usr/sbin/alternatives --config java

Installing Sun JRE 6 Manually


This method works on both RedHat Enterprise Linux and CentOS systems.
To install Sun JRE 6 manually:
1. Check your hardware architecture by running:

uname -i

x86_64 indicates that you should download the “Linux 64” Java version and ix86
indicates you should download “Linux” version of Java.

2. Download the appropriate version of Java for your architecture

RiverMuse ECM Installation Guide 15


Addendum A: Configuring Sun JRE 6

from http://www.java.com/en/download/manual.jsp?locale=en&host=www.java.com.
Get the RPM version for ease of installation.
3. Install Sun JRE 6 by running the following command:

sudo sh jre-6u24-linux-x64-rpm.bin

4. Inform the system about the newly installed version of Sun JRE 6 by running the
following command:
sudo /usr/sbin/alternatives --install /usr/bin/java java
/usr/java/jre1.6.0_24/bin/java 10000

5. Configure the system to use the newly installed Sun JRE 6 by default by running the
following command:
sudo /usr/sbin/alternatives --config java

16 RiverMuse ECM Installation Guide

You might also like