Skip to content

FRAM

With FRAM (FusionReactor Administration Manager) installed, you are now in a position that you are able to install FusionReactor instances onto your application servers.

FRAM is not a full instance of FusionReactor, it includes the Instance Manager and Enterprise Dashboard only.

The intention for a FRAM instance is to be used to install instances of FusionReactor on your Application Server and to host a dashboard for your FusionReactor instances to be displayed on.

Video

Scanning the local file system for your Application Servers

In order for the Instance Manager to install instances of FusionReactor on your Application Servers, they must first be detected as being installed on the server.

To do this within the Instance Manager you can use the Scan System functionality of FRAM. To scan the system you can specify the Root Scan Directory and the Scan Depth.

The Root Scan Directory will default to the server root; / for unix and C:\ for Windows. We recommend that instead of scanning the entire root directory you specify the path to a specific application directory to save time when scanning the file system.

The Scan depth is the number of sub directories that will be scanned when you click Scan System. We recommend keeping this number low when possible as scanning the full local file system can take a significant amount of time.

Note

It is important to ensure that the user running FRAM must have sufficient permissions to scan the directory of your Application Server. If for example your FRAM Service is running as a system user and the directory is owned by the administrator we will not be able to detect the server.

When you scan the system, FusionReactor will scan for specific files that allow it to identify the type of Application Server that is installed. An Entry for each Application Server will be created when the scan is completed.

Now that the Application Servers have been detected FusionReactor can be installed.

Configuring a FusionReactor instance on your application server

To configure a FusionReactor instance on your Application Server you can click the ‘plus icon' within the instance manager. This will launch the instance configuration wizard.

The first view you see is the Configure Settings tab, this allows you configure the instance name and connection settings for the instance.

The Instance Name will default to the name of the Application Server, but can be modified to any value.

The FR Port and FR Address fields refer to the configuration of the Internal Web Server.

  • The FR Port will default to port 8088, if this port is in use the port number will increment accordingly.
  • The FR Address binds the FusionReactor port to a specific IP address if enabled, if this setting is disable the port will be bound to 0.0.0.0 and listen on all addresses.

The External Web Server Access setting will disable the access to FusionReactor via the External Web Server, making it so that you can only access FusionReactor via the Internal Web Server.

Clicking Next will display the Instance Password tab.

Here you must specify a password for FusionReactor and confirm the password. Clicking next will display the instance within the [Enterprise Dashboard]../Enterprise-Dashboard/Enterprise-Dashboard.md) tab.

Here you can choose whether to add this instance to your Enterprise Dashboard.

Note

If you plan to use the Ephemeral Data Service you should select no.

Clicking next will show the Options tab. Here you can specify how the Application Server should be started.

When possible FusionReactor will default it’s settings to automatically configure and run your Application server so that FusionReactor can be installed.

The Start / Stop Options are:

  • Use the Windows / Linux Service (FRAM will make a call to the service to start, stop or restart the service)
  • Use the Application Server run command (FRAM will run the run command to start, stop or restart the Application Server)
  • Manually start/stop the server (This option requires you to start and stop the Application Server yourself)

The Install / Uninstall options are:

  • Automatically configure the Application Server config file (FRAM will inject the required java arguments into the Application Server configuration)
  • Manual Configuration (This option requires you to manually add JVM arguments to your Application Server config file)

Warning

If you only have the option to Manually start/stop the server and Manual Configuration this indicates that the FRAM user is unable to execute commands or modify files in the directory of the Application Server. You should ensure that the user running the FRAM service can read and write to the directory of the Application Server to correct this.

The Restart Server option will specify whether your Application server should be restarted after the jvm arguments have been configured.

Warning

It is important to understand that if your Application Server is running and you select ‘No’, the Application Server will be stopped and NOT restarted.

Clicking Next will show the Confirm Settings modal. Here if you click confirm the instance of FusionReactor will be installed. If successful you will be redirected to the Instance Manager, where you will see a link to the FusionReactor instance.

If any error occurs during installation you will see a Start Failed modal.

When FusionReactor Attempts to start the instance, there is a timeout of 30 seconds in place, if your Application Server takes longer than 30 seconds to start, you may see Start Failed and as soon as the server comes online your server will then be running.

You can check the Instance Manager log file to diagnose why the start command failed. Likely causes for this are:

  • There was a permissions issue starting the Application Server
  • The start up process timed out
  • There was No JRE specified for the Application Server

Upgrading the FusionReactor instance on your application server

Upgrading an installed instance of FusionReactor requires you to first upgrade the FRAM installation:

To Upgrade the Full Installer see Upgrade Full Installer To upgrade the Preconfigured Installer see Upgrade Preconfigured Installer

Once the FRAM instance has been upgraded, in the Instance Manager you will see an upgrade button appear next to the Stop, Start/Restart and Remove buttons.

Note: In order to upgrade FusionReactor the Application Server must be restarted, you may need to schedule the upgrade at a period of time where downtime is allowed.

Clicking the upgrade button will trigger the upgrade process.

In the Configure Instance modal, you can specify whether to restart the Application Server.

Warning: It is important to understand that if your Application Server is running and you select ‘No’, the Application Server will be stopped and NOT restarted.

Clicking Next and then clicking confirm will upgrade FusionReactor and Restart your Application Server.

Uninstalling a FusionReactor instance from your application server

You can uninstall an instance of FusionReactor by clicking the delete button within the Instance Manager.

Note

In order to uninstall FusionReactor the Application Server must be restarted, you may need to schedule the removal at a period of time where downtime is allowed.

Clicking the remove button will trigger the removal process.

In the Configure Instance modal, you can specify whether to restart the Application Server.

Warning

It is important to understand that if your Application Server is running and you select ‘No’, the Application Server will be stopped and NOT restarted.

Clicking Next and then clicking confirm will remove FusionReactor and Restart your Application Server.