Skip to content
objectiser edited this page Jun 5, 2013 · 20 revisions

Installation

This section will describe how to install Overlord Runtime Governance in different environments.

JBoss Application Server

This section describes how to install Overlord Runtime Governance into the JBoss Application Server.

Install

Download the latest release from the Overlord Runtime Governance website, selecting the distribution specific to JBoss AS. Then unpack the distribution into a suitable location.

Make sure that the JBOSS_HOME environment variable is set to the root folder of the JBoss AS installation.

The final step is to perform the installation using maven. You will need maven 3.0.4 or higher, and can be downloaded from here: http://maven.apache.org/download.html

To do the installation, use the following command from the root folder of the installation:

mvn install [ -Dtype=<installation-type> ]

The 'installation-type' value can be:

Value Description

server

This will result in the full server configuration being installed into the server. This is the default value.

restc

This will result in only the activity collector functionality being installed, using a RESTful client to communicate with a remote Runtime Governance server.

Configuration

The configuration for the Runtime Governance capability within a JBoss AS environment can be found in the file $JBOSS_HOME/standalone/configuration/overlord-rtgov.properties. Although there will be some properties that are independent of the installation type, some will be specific and therefore are listed in separate sections below.

Common Properties

The common properties available across all installation types are:

Property Description

collectionEnabled

This property will determine whether activity information is collected when the server is initially started. This value can be changed at runtime using the ActivityCollector MBean (see the chapter on Managing the Infrastructure).

Properties for the "server" Installation Type

When installing the full Runtime Governance server, modification to the configuration will generally only be necessary if running in a clustered environment and/or wishing to use a particular database. The default installed environment is intended to work "out of the box", and uses an in-memory H2 database.

However, specific technologies used in the Activity Server, Event Processor Network or Active Collection modules may need to use different configuration properties to work correctly within a clustered environment. More details will be provided in sections discussing those technologies, however here we will present the common changes that may be required.

Database

The database is defined by the configuration in two places:

(i) The datasource is configured in the $JBOSS_HOME/standalone/deployment/overlord-rtgov/rtgov-ds.xml.

(ii) Properties supplied to the Entity Manager are configured in the overlord-rtgov.properties file.

Caching

The EPN and Active Collection mechanisms both have the ability to make use of caching provided by infinispan. When running the AS7 server in clustered mode (i.e. with standalone-full-ha.xml), the server provides a default clustered cache container, which is referenced in the 'infinispan.container' property in the overlord-rtgov.properties file. Simply uncomment this property to enable the EPN and Active Collection Source configurations that do not explicitly provide a container JNDI name, to make use of this default clustered cache container.

However, to make sure the individual named caches are clustered correctly, it is necessary to add an entry for each cache into the standalone-full-ha.xml file. As an example, the following cache entry for the "Principals" cache has been defined, for use with the Policy Enforcement example:

            <cache-container name="cluster" aliases="ha-partition" default-cache="default">
                <transport lock-timeout="60000"/>
                <replicated-cache name="default" mode="SYNC" batching="true">
                    <locking isolation="REPEATABLE_READ"/>
                </replicated-cache>

                <!-- Configuration for Runtime Governance caches -->

                <replicated-cache name="Principals" mode="SYNC">
                    <locking isolation="REPEATABLE_READ"/>
                    <transaction mode="FULL_XA" locking="PESSIMISTIC"/>
                </replicated-cache>
            </cache-container>
Properties for the "restc" Installation Type

This installation type is used to configure an execution environment that will be sending its activity information to a remote Runtime Governance server using REST. The relevant properties are:

Property Description

serverURL

This is the URL of the activity server collecting the activity events.

Uninstall

To uninstall, simply perform the following command in the root folder of the installation, ensuring that the JBOSS_HOME environment variable refers to the root location of the JBoss AS environment:

mvn clean