Difference between revisions of "EdgeServerInstall"

From Fusion Registry Wiki
Jump to navigation Jump to search
(→‎Modifying Edge Server Directory)
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
[[Category:Fusion Edge Server]]
 +
[[Category:FESInstall]]
 
= Overview =
 
= Overview =
 +
The Fusion Edge Server is designed to be deployed across multiple servers and positioned behind a load balancer to achieve [https://en.wikipedia.org/wiki/High_availability high availability].  Strategies can be put in place with regards to rolling deploys for software upgrade, and different techniques can be used to support data and metadata updates.
  
 +
For simple deployments, including testing, installing the Fusion Edge server can be a very fast, painless experience.  Simply install [http://tomcat.apache.org/ Apache Tomcat], and [https://www.java.com/en/download/ Java], and put the Fusion Edge Server application (war file) into tomcat/webapps and launch Tomcat. 
 +
 +
This guide provides information on how to deploy and load Fusion Edge Server with a single Tomcat instance.
  
 
= Quick Start with Apache Tomcat =
 
= Quick Start with Apache Tomcat =
Line 22: Line 28:
 
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.
 
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 ==
+
== Configure Fusion Edge Server ==
−
In order to deploy content to the Fusion Edge server, the file which contains the content needs to be placed in the '''sweep''' directory of the Fusion Edge Server.
+
Configure the [[Fusion_Edge_Server_Properties|edgeserver.properties]] file in the Fusion Edge Server [[Fusion_Edge_Server_Directory|home directory]].
−
 
 
−
The location of the Fusion Edge Server Directory defaults to:
 
−
<user home>/MetadataTechnology/FusionEdgeServer
 
−
 
 
−
On a Windows 10 Operating System this will typically be:
 
−
C:\users\<your user name>\MetadataTechnology\FusionEdgeServer
 
−
 
 
−
On a Unix Operating System, the likely location is:
 
−
/home/<your user name>/MetadataTechnology/FusionEdgeServer
 
  
−
The Fusion Edge Server creates the following directories on start-up, if they do not already exist. The directories are:
+
== Publish Content ==
−
* '''sweep''' – This folder is periodically polled by the Fusion Edge Server to check for new data
+
Once the Fusion Edge Server web application has been configured, please refer to the following [[Edge_Server_-_Publish_Content|guide]] on how to publish data and metadata.
−
* '''processing''' – The Fusion Edge Server copied swept files into this folder for processing
 
−
* '''processed''' – The Fusion Edge Server moves successfully imported files into this folder, and imports any content from this folder on application start-up
 
−
* '''tmp''' – This folder is used to store both short lived temporary files, and longer lived cached datasets
 
  
 
== Test Web Service ==
 
== 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:
+
The structural metadata, data, and reference metadata held in the Fusion Edge Server is made available via SDMX compliant web services.  
  
 
  http(s)://[server]:[port]/FusionEdgeServer/ws/public/sdmxapi/rest
 
  http(s)://[server]:[port]/FusionEdgeServer/ws/public/sdmxapi/rest
Line 48: Line 42:
  
 
  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 =
 
−
 
−
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: [[Fusion Edge Server Properties|edgeserver.properties]].
 

Latest revision as of 08:40, 11 September 2023

Overview

The Fusion Edge Server is designed to be deployed across multiple servers and positioned behind a load balancer to achieve high availability. Strategies can be put in place with regards to rolling deploys for software upgrade, and different techniques can be used to support data and metadata updates.

For simple deployments, including testing, installing the Fusion Edge server can be a very fast, painless experience. Simply install Apache Tomcat, and Java, and put the Fusion Edge Server application (war file) into tomcat/webapps and launch Tomcat.

This guide provides information on how to deploy and load Fusion Edge Server with a single Tomcat instance.

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.

Configure Fusion Edge Server

Configure the edgeserver.properties file in the Fusion Edge Server home directory.

Publish Content

Once the Fusion Edge Server web application has been configured, please refer to the following guide on how to publish data and metadata.

Test Web Service

The structural metadata, data, and reference metadata held in the Fusion Edge Server is made available via SDMX compliant web services. 

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
Retrieved from "https://wiki.sdmxcloud.org/index.php?title=EdgeServerInstall&oldid=6123"