17 March 2024

GigaSpaces Over a Firewall

In many scenarios, you need to set up our product in environments which have a firewall running. This section provides GigaSpaces configuration recommendations for several firewall topologies:

Basic configuration: GigaSpaces cluster (GSM Grid Service Manager. This is is a service grid component that manages a set of Grid Service Containers (GSCs). A GSM has an API for deploying/undeploying Processing Units. When a GSM is instructed to deploy a Processing Unit, it finds an appropriate, available GSC and tells that GSC to run an instance of that Processing Unit. It then continuously monitors that Processing Unit instance to verify that it is alive, and that the SLA is not breached. and GSCs) running behind the firewall, with clients connecting through the firewall. Multicast traffic is allowed behind the firewall and unicast-only traffic comes from the clients through the firewall.

Basic configuration, suitable for most scenarios, requires mandatory setting of the following properties (these system property settings are described below):

com.gs.multicast.discoveryPort
com.gigaspaces.start.httpPort
com.gs.transport_protocol.lrmi.bind-port
com.sun.jini.reggie.initialUnicastDiscoveryPort

Same topology as above: All cluster components and clients communicate over unicast only. Multicast traffic is prohibited.
The firewall divides the GigaSpaces cluster into zones. Some components (GSCs, GSM) run in one firewall zone, while the rest REpresentational State Transfer. Application Programming Interface An API, or application programming interface, is a set of rules that define how applications or devices can connect to and communicate with each other. A REST API is an API that conforms to the design principles of the REST, or representational state transfer architectural style. of the components run in another firewall zone(s). Only unicast traffic is allowed between firewall zones.

To learn more about GigaSpaces port usage, see the Port Usage Control page.

GigaSpaces Firewall Settings

To enable all GigaSpaces components to work over a firewall and control all network activity through explicitly defined static ports:

All communications traversing the firewall should be switched to Unicast TCP (use GigaSpaces Jini unicast lookup locators and set the -Dcom.gs.multicast.discoveryPort as described in the next section). Jini Multicast discovery should be disabled.
Specific listener ports of system components should be statically set.
Necessary listener port ranges should be defined per each IP address, where the GigaSpaces server components reside.

Components such as GSM/Lookup Service, GSC Grid Service Container. This provides an isolated runtime for one (or more) processing unit (PU) instance and exposes its state to the GSM., and Mahalo use a single Webster (HTTPD service) and a single LRMI transport port per component. Accordingly, the same quantity of Webster and LRMI ports should be planned for each IP address where those components reside.

Port ranges should be chosen continuously, as Webster and LRMI port bindings are performed sequentially, beginning from the low port number. Each additional component started on the same machine opens a sequentially higher Webster and LRMI port, beginning from the low port in the defined port range.
Firewall rules for incoming traffic should include opening a TCP port for each statically defined GigaSpaces component listener, for each IP address where a GigaSpaces component is running (excluding the JMX MBean server).
JMX listener ports that are presented in GigaSpaces components and assigned by the RMIRegistry mechanism (the default port range begins at 10098; each component opens the next available port) can remain dynamically assigned and should not be opened in the firewall. JMX connections are dedicated to administrative purposes and can be accessed by monitoring tools behind the firewall. The MBeanServer and the RMI lookup are not available outside the firewall.
Each static GigaSpaces listener port behind the firewall should be mapped by NAT to the static IP address outside of the firewall. GigaSpaces clients/servers residing outside of the firewall should be set to work versus statically mapped by NAT listeners outside IP addresses.
Mandatory – the range of port numbers (just free unassigned ports allowed) should be above 1024 and below 65536.

Recommended port ranges - as per IANA standards, port numbers are based on three ranges: System Ports (0-1023), User Ports (1024-49151), and the Dynamic and/or Private Ports (49152-65535). Select your port range from the available user ports or dynamic ports.

Listener Ports per GigaSpaces Component

Component	Listeners
GSM	Lookup Service LRMI Transport Webster JMX
GSC	LRMI Transport Webster JMX
Transaction Manager (Mahalo)	LRMI Transport Webster JMX

Required Configuration Modifications

bin/gs.sh Script Modifications

Add the following system properties to the command line:

Optional – For unicast-only solutions, use the following system property to disable the Jini multicast activity:
```
-Dcom.gs.multicast.enabled=false
```

Mandatory – Reggie Lookup Service: in this context, modify com.gs.multicast.discoveryPort, the port used during discovery for both unicast and multicast requests. The default value is 4174.
```
-Dcom.gs.multicast.discoveryPort=
```

Mandatory – Reggie Lookup Service: in this context, modify com.sun.jini.reggie.initialUnicastDiscoveryPort, the port used during unicast discovery. The default value is 0 (undefined).

If you leave the unicast discovery port property com.sun.jini.reggie.initialUnicastDiscoveryPort unconfigured (with its default value of 0), then it will use the port value in the com.gs.multicast.discoveryPort property.
```
-Dcom.sun.jini.reggie.initialUnicastDiscoveryPort=
```

Optional – RMIRegistry port (used for RMI lookup and for JMX MBean server). The default value is 10098.
```
-Dcom.gigaspaces.system.registryPort=
```

Mandatory – Webster HTTPD service port.
```
-Dcom.gigaspaces.start.httpPort=
```

Sample port settings:

-Dcom.gs.multicast.enabled=false
-Dcom.gs.multicast.discoveryPort=7102
-Dcom.gigaspaces.system.registryPort=7103
-Dcom.gigaspaces.start.httpPort=7104

bin/gs-ui.sh GUI Script Modifications (Optional)

The GigaSpaces Management Center has been deprecated and will be removed in a future release.

These modifications are only needed when a GUI client should connect through the firewall. Add the following system properties to the command line:

Mandatory – use the following system property to disable the Jini multicast activity. For unicast-only solutions:
```
-Dcom.gs.multicast.enabled=false
```

Mandatory – Reggie Lookup Service: in this context, modify com.gs.multicast.discoveryPort, the port used during discovery for both unicast and multicast requests. The default value is 4174.
```
-Dcom.gs.multicast.discoveryPort=
```

Mandatory – RMIRegistry port (used for RMI lookup and for JMX MBean server). The default value is 10098.
```
-Dcom.gigaspaces.system.registryPort=
```

Optional – Webster HTTPD service port.
```
-Dcom.gigaspaces.start.httpPort=
```

Sample port settings:

-Dcom.gs.multicast.enabled=false
-Dcom.gs.multicast.discoveryPort=7102
-Dcom.gigaspaces.system.registryPort=7103
-Dcom.gigaspaces.start.httpPort=7104

bin/setenv.sh Script Modifications (Mandatory)

Lookup locators unicast discovery port should be the same as defined in gs.sh, for example:

GS_LOOKUP_LOCATORS=server111:7102; export GS_LOOKUP_LOCATORS

LRMI Communication Protocol Port Range Setting Modifications

The com.gigaspaces.start.httpPort Webster port number property can be defined by overriding as shown below, or using a system property:

gsm.sh webster.xml
gsc.sh webster.xml
startJiniTX_Mahalo.sh webster.xml

Content of override file for Webster port definitions:

<overrides>
    <Component Name="com.gigaspaces.start">
        <Parameter Name="httpPort" Value="9099"/>
    </Component>
</overrides>