JBoss.orgCommunity Documentation

Chapter 2. Installing JBoss Operations Network and JBoss Communications JAIN SLEE Plugin

2.1. Pre-Install Requirements and Prerequisites
2.1.1. Hardware Requirements
2.1.2. Software Prerequisites
2.2. Install JBoss Operations Network and JBoss Communications JAIN SLEE Plugin
2.2.1. Installing JBoss Operations Network Server and Agent
2.2.2. Installing the JBoss Communications JAIN SLEE Plugin

Ensure that the following requirements have been met before continuing with the install.

JDK 5 or Higher

A working installation of the Java Development Kit (JDK) version 5 or higher is required in order to run the JBoss Operations Network. Note that JBoss Enterprise Application Platform is a runtime dependency, but comes bundled with the binary distribution.

For instructions on how to install the JDK, refer to Appendix A, Java Development Kit (JDK): Installing, Configuring and Running.

External Database

In order to run JBoss Operations Network, an external database must be installed.

Use of Embedded H2 database

JBoss Operations Network is distributed with a Java embedded database called "H2", so if you are just running JBoss Operations Network to test it out and play with it, you can use that and not install an external database. But this Embedded H2 database is to be considered only for demo'ing and testing purposes. For production systems, you will need to install an external database.

The supported databases are:

PostgreSQL

Postgres versions 8.2.4 and higher are supported.

Oracle

Oracle versions 10g and 11g are supported.

After installing the database, make note of the JDBC URL, username and password for the database. This information is required during the JBoss Operations Network Server installation.

JBoss Operations Network is based on and plugin-compatible with the multi-vendor RHQ management project. For the JBoss Communications Plugin to work correctly, version 1.4.x of RHQ is required.

Since there's no released version of JBoss Operations Network based on RHQ 1.4.x yet, RHQ itself will be used instead.

  1. Download RHQ Server from SourceForge. This is the platform server, which will be responsible for storing, processing and presenting the data received by the agent(s).

  2. Unzip the distribution in a suitable place (i.e. in a directory not too deeply nested and with no spaces or non-ASCII characters in its name)

  3. This step is optional, if you're using Embedded H2 Database, you can skip to next

    Install a database like PostgreSQL (version 8.2.4 +, please choose C locale for initdb), create a database instance called 'rhq' in it and a user 'rhqadmin' that owns this 'rhq' database.

    create user rhqadmin password 'rhqadmin';
    
    	create database rhq owner rhqadmin;
  4. Eventually set RHQ_SERVER_JAVA_HOME or RHQ_SERVER_JAVA_EXE_FILE_PATH env variables appropriately. This is needed if your JAVA_HOME does not point to a java installation that is valid with JBoss Operations Network (e.g. JAVA 1.4); JBoss Operations Network requires JAVA 5+.

  5. In a terminal console, cd into the installation directory and start the Server:

    bin/rhq-server.[sh|bat] console
  6. After a few seconds, the messages on the console will stop. When this happens, point your browser to http://localhost:7080/ and run the installer:

    1. Click on Click here to continue the installation

    2. Choose your desired and installed database from the Database Type drop down list. If you don't want to install/use an external Database, choose H2 (embedded).

    3. Default settings should be fine to install the server correctly. To test the DB connection, please click Test Connection button.

      Warning

      If the Test Connection button was used, make sure that the Database Password field is still filled, as some browsers lose the data in there. Default password is rhqadmin.

    4. Review the seleceted settings, click Install Server! and wait for it to complete.

    5. Click on Done! Click here to get started! when the progress bar stops.

  7. Log in (default user/password are: rhqadmin/rhqadmin), it is time to download and install the Agent.

    The Agent is the component where our plugin will be running at. It is responsible for communicating with the managed resource (in this situation, the JAIN SLEE Server) to obtain vital data (eg: availability), metrics, operations execution, etc. and report back to the Server, who will process and display that data.

    To download it, follow these steps:

    1. Click on AdministrationDownload.

      Figure 2.1. Accessing Download Menu


    2. Click on Download Agent Installer and save it to where you wish to have it installed.

    3. In a second terminal console, cd into the directory containing the downloaded jar and install it:

      java -jar <agent-download.jar> --install[=<new agent dir>]

      The optional parameter, new agent dir indicates where the files will be installed, and defaults to the path where the jar is at.

    4. cd into the newly created rhq-agent directory and start the Agent by issuing:

      bin/rhq-agent.[sh|bat]
    5. Answer the questions asked by the Agent, if any. Default setting should be sufficient.

    6. There should be a console with a '> ' prompt. Don't close it, leave it running, it's the agent who will perform all the work.

For more detailed and up to date information, visit the JBoss Operations Network installation instructions.

JBoss Communications JAIN SLEE Plugin is the interface between JBoss Operations Network and JBoss Communications JAIN SLEE. It is responsible for gathering data from SLEE and transform it to JBoss Operations Network format. It is an agent plugin, since it runs on the agent side.

JBoss Communications JAIN SLEE Plugin, may be installed in two ways:

Using the GUI

In the JBoss Operations Network GUI, in the top menu, head to AdministrationSystem ConfigurationPlugins:

Figure 2.2. Accessing Plugins Menu


On the Agent Plugins tab (selected by default), on the bottom of the page, click Add..., browse to the JBoss Operations Network plugin JAR file and select it. It will be listed for upload, as it can be seen in the following figure:

Figure 2.3. Uploading Plugin


Finally, click the Upload button and the plugin will be deployed. Click Scan for Updates and it should be shown in the list as "Mobicents JSLEE Server 2.x".

If the agent is not running, start it and it will automatically download the new plugin. If it was already running, you should run the following command in it's console to download/update the plugin:

> plugins update
Copying the JAR File

The plugin can be deployed simply by copying it to the right folder, by following these steps:

  1. Stop the JBoss Operations Network server and agent if they are running.

  2. Copy the mobicents-slee-jopr-as-5-plugin-<version>.jar to the jopr-server/jbossas/server/default/deploy/rhq.ear/rhq-downloads/rhq-plugins/ directory, and it will be automatically deployed.

  3. Start the JBoss Operations Network server.

  4. Start the JBoss Operations Network agent.

After the plugin is installed, the server must be added to the managed resources. Choose OverviewAuto Discovery Queue:

Figure 2.4. Accessing Auto Discovery Queue Menu


Note

Please make sure that the JAIN SLEE Server is running at this time, otherwise it won't be shown under Auto Discovery.

JAIN SLEE Server not showing in Auto Discovery?

If the JAIN SLEE Server is running but not shown in the list, issue the following commands in th Jopr Agent console:

> plugins update
...

> discovery

Back in the web console, refresh the Auto Discovery view and it should be present!

Check the option referring to JAIN SLEE Server (as in the figure below), and click IMPORT button.

Figure 2.5. Selecting the server to be imported into JBoss Operations Network.


Now the server is being can be managed and monitored with JBoss Operations Network.