Difference between revisions of "EdgeServerInstall"

From Fusion Registry Wiki
Jump to navigation Jump to search
(Deploy Content to the Fusion Edge Server)
(Modifying Edge Server Directory)
Line 38: Line 38:
 
  https://localhost:8080/FusionEdgeServer/ws/public/sdmxapi/rest/dataflow
 
  https://localhost:8080/FusionEdgeServer/ws/public/sdmxapi/rest/dataflow
  
 
= Modifying Edge Server Directory =
 
The location of the Edge Server Directory can be changed by supplying a Java System variable to the JVM on tomcat launch.
 
 
The easiest way to achieve this is to create a new file named setenv.bat (or setenv.sh on Unix environments) and place it in the tomcats bin directory. The contents of this file should state the full location of the properties directory which should be in the appropriate format for your operating system. To illustrate this:
 
 
SET JAVA_OPTS=-DEdgeServerDir=c:/dir/MyDirectory
 
(For Windows systems)
 
 
export JAVA_OPTS=-DEdgeServerDir =/dir/MyDirectory
 
(For Unix systems)
 
 
'''Note''': Fusion Edge Server will NOT start if this value is incorrect or if this directory cannot be written to.
 
  
 
= Edge Server Runtime Properties =
 
= Edge Server Runtime Properties =

Revision as of 02:38, 3 May 2020

Overview

Quick Start with Apache Tomcat

Deploy Application and Launch Web Server

The Fusion Edge Server consists of a single .war file called FusionEdgeServer.war.

  1. Copy FusionEdgeServer.war into the directory: <TOMCAT_HOME>/webapps
  2. Start the Tomcat Server
  3. Check the Tomcat <TOMCAT_HOME>/logs to ensure there are no errors in the log files

During the Tomcat start-up process, the war file will be unpacked into a directory of the same name, for example:

<TOMCAT_HOME>/webapps/FusionEdgeServer

On successful launch the Fusion Edge Server product information service can be queried from the following URL:

http://[server]:[port]/FusionEdgeServer/ws/fusion/info/product

The values for server and port must be replaced with the IP address and port number that the web application server is running on. For example, if the web browser is running on the same machine as the web application server and the Apache Tomcat has not had its default port settings modified, then the following address can be used:

http://localhost:8080/FusionEdgeServer

The Fusion Edge Server is now deployed and running in a web container, the URL will result in an empty (white page) - remeber the purpose of the FusionEdgeServer is to host a READ ONLY REST API to your SDMX Structural Metadata, Data, and Reference Metadata. The Fusion Edge server has no User Interface, so the white empty page is a good thing. The REST API of the Fusion Edge Server can be used to browse your content, which should be currently empty.

Deploy Content to the Fusion Edge Server

In order to deploy content to the Fusion Edge server, a single file named node.zip should be placed in the sweep Fusion Edge Server Directory.

The node.zip file is copied into the sweep folder, this folder is scanned by the Fusion Edge Server every few seconds, and when a new node.zip file is detected the Fusion Edge Server moves it into the processing directory while it builds the new environment. When the environment is built, the file is mored into the processed directory and all content will be queryable via the Fusion Edge Server's web services.

If the Tomcat server is shut down and relaunched, it will reload the environment from the processed folder as part of the startup process. The Tomcat server will only come into service once the environment is loaded.

Test Web Service

The structural metadata, data, and reference metadata held in the Fusion Edge Server is made available via SDMX compliant web services. The web service entry point for the Node is available at:

http(s)://[server]:[port]/FusionEdgeServer/ws/public/sdmxapi/rest

A test query can be issued, for example:

https://localhost:8080/FusionEdgeServer/ws/public/sdmxapi/rest/dataflow


Edge Server Runtime Properties

The Fusion Edge Server provides configuration options on various aspects of the Edge Server.

To set these configurations, create a file under the Edge Server Directory with the name: edgeserver.properties.