Configuring the Environment Variables

This topic explains how the GigaSpaces and InsightEdge environments are configured, and how to customize them to suit your specific application needs.

GigaSpaces

The GigaSpaces environment configuration is maintained by a configuration script file called setenv, located in the GS/bin directory. Each GigaSpaces script invokes this script to load the GigaSpaces configuration. If you are developing a standalone GigaSpaces client, it is recommended to use the setenv utility to derive the commonly used GigaSpaces libraries and setup environment.

To use this utility, you can simply call it from within your script file.

InsightEdge

The InsightEdge environment configuration is maintained by a configuration script file called insightedge-env, located in the GS/insightedge/conf directory. Each InsightEdge script invokes this script to load the InsightEdge configuration. Additionally, insightedge-env starts by invoking the GigaSpaces setenv configuration script, so all of the GigaSpaces environment configuration is also applied.

Customizing the Environment Variables

During the initial development stages, it is usually unnecessary to change any of the default GigaSpaces environment values. However, at some point the environment will need customization to suit your specific requirements (such as the Grid Service Container heap size).

Do not make changes to the original setenv script, as it complicates upgrading GigaSpaces later on. Instead, use the setenv-overrides script, which is automatically called by setenv and is intended for specifying custom overrides in a safe manner.

GigaSpaces Environment Variables

The following list describes GigaSpaces-related environment variables:

Name Description Default Value
JAVA_HOME The directory in which Java is installed.
GS_HOME The GigaSpaces GigaSpaces home directory. Automatically set via the folder structure
GS_LICENSE License key (for Premium and Enterprise editions).
GS_LOOKUP_GROUPS Lookup Service groups used for multicast discovery. xap-15.0.0
GS_LOOKUP_LOCATORS Lookup Service Locators used for unicast discovery.
GS_NIC_ADDRESS The network interface card that will be used by GigaSpaces. Automatically set to the host name
GS_SECURITY_POLICY The default policy file. GS_HOME/policy/policy.all
GS_LOGS_CONFIG_FILE The location of the GigaSpaces logging configuration. GS_HOME/config/log/xap_logging.properties
GS_MANAGER_SERVERS Set the list of Manager servers that other machines can connect to.
GS_PUBLIC_HOST Define the public IP address for the Docker host machine.
GS_MANAGER_OPTIONS Java options for the GigaSpaces Manager.
GS_GSC_OPTIONS Java options for the Grid Service Container (GSC).
GS_GSM_OPTIONS Java options for the Grid Service Manager (GSM).  
GS_GSA_OPTIONS Java options for the Grid Service Agent (GSA)
GS_LUS_OPTIONS Java options for the Lookup Service (LUS).  
GS_ESM_OPTIONS Java options for the Elastic Service Manager (ESM).
GS_GUI_OPTIONS Java options for the GigaSpaces Management Center.
GS_WEBUI_OPTIONS Java options for the Web Management Console.
GS_OPTIONS_EXT

Append these options to the default GigaSpaces GigaSpaces options.

 

 
GS_OPTIONS

Override the default GigaSpaces GigaSpaces options.

For use by GigaSpaces engineers. To add options, use GS_OPTIONS_EXT.
 
GS_LIBRARY_PATH_EXT Override the default GigaSpaces library path and set java.library.path to this path.  
GS_LIBRARY_PATH Append the path to the default GigaSpaces library path and set java.library.path to the result.  

  When running in ./gs-agent --manager configuration, this environment variable is ignored.

InsightEdge Environment Variables

The following list describes InsightEdge-related environment variables:

Name Description Default Value
SPARK_HOME The directory where Spark is installed GS_HOME/insightedge
INSIGHTEDGE_CLASSPATH_EXT Extra classpath to append to InsightEdge components
INSIGHTEDGE_SPACE_NAME Space name to use in InsightEdge scripts and examples demo

In addition, you can also use standard Spark environment variables. The InsightEdge Platform loads Spark components in a manner that preserves their usage. For example, set SPARK_MASTER_PORT to override the default 7077 port.

Upgrading from Previous Versions

Environment variables in InsightEdge 15.0 are modified to start with a GS_ prefix in place of the previous XAP_ prefix. To support existing scripts that include environment variables with the XAP_ prefix, the product reads InsightEdge-specific environment variables, with both a GS_ prefix and a XAP_ prefix. Therefore if you are upgrading from a previous version, you don't have to modify your scripts right away (although we recommend that you do it eventually).