Chapter 12. Reference

12.1. Data Grid Server 8.1.1 Readme

Information about the Data Grid Server 11.0.9.Final-redhat-00001 distribution.

12.1.1. Requirements

Data Grid Server requires JDK 11 or later.

12.1.2. Starting servers

Use the server script to run Data Grid Server instances.

Unix / Linux

$RHDG_HOME/bin/server.sh

Windows

$RHDG_HOME\bin\server.bat

Tip

Include the --help or -h option to view command arguments.

12.1.3. Stopping servers

Use the shutdown command with the CLI to perform a graceful shutdown.

Alternatively, enter Ctrl-C from the terminal to interrupt the server process or kill it via the TERM signal.

12.1.4. Configuration

Server configuration extends Data Grid configuration with the following server-specific elements:

cache-container
Defines cache containers for managing cache lifecycles.
endpoints
Enables and configures endpoint connectors for client protocols.
security
Configures endpoint security realms.
socket-bindings
Maps endpoint connectors to interfaces and ports.

The default configuration file is $RHDG_HOME/server/conf/infinispan.xml.

Use different configuration files with the -c argument, as in the following example that starts a server without clustering capabilities:

Unix / Linux

$RHDG_HOME/bin/server.sh -c infinispan-local.xml

Windows

$RHDG_HOME\bin\server.bat -c infinispan-local.xml

12.1.5. Bind address

Data Grid Server binds to the loopback IP address localhost on your network by default.

Use the -b argument to set a different IP address, as in the following example that binds to all network interfaces:

Unix / Linux

$RHDG_HOME/bin/server.sh -b 0.0.0.0

Windows

$RHDG_HOME\bin\server.bat -b 0.0.0.0

12.1.6. Bind port

Data Grid Server listens on port 11222 by default.

Use the -p argument to set an alternative port:

Unix / Linux

$RHDG_HOME/bin/server.sh -p 30000

Windows

$RHDG_HOME\bin\server.bat -p 30000

12.1.7. Clustering address

Data Grid Server configuration defines cluster transport so multiple instances on the same network discover each other and automatically form clusters.

Use the -k argument to change the IP address for cluster traffic:

Unix / Linux

$RHDG_HOME/bin/server.sh -k 192.168.1.100

Windows

$RHDG_HOME\bin\server.bat -k 192.168.1.100

12.1.8. Cluster stacks

JGroups stacks configure the protocols for cluster transport. Data Grid Server uses the tcp stack by default.

Use alternative cluster stacks with the -j argument, as in the following example that uses UDP for cluster transport:

Unix / Linux

$RHDG_HOME/bin/server.sh -j udp

Windows

$RHDG_HOME\bin\server.bat -j udp

12.1.9. Authentication

Data Grid Server requires authentication.

Create a username and password with the CLI as follows:

Unix / Linux

$RHDG_HOME/bin/cli.sh user create username -p "qwer1234!"

Windows

$RHDG_HOME\bin\cli.bat user create username -p "qwer1234!"

12.1.10. Server home directory

Data Grid Server uses infinispan.server.home.path to locate the contents of the server distribution on the host filesystem.

The server home directory, referred to as $RHDG_HOME, contains the following folders:

├── bin
├── boot
├── docs
├── lib
├── server
└── static
FolderDescription

/bin

Contains scripts to start servers and CLI.

/boot

Contains JAR files to boot servers.

/docs

Provides configuration examples, schemas, component licenses, and other resources.

/lib

Contains JAR files that servers require internally.
Do not place custom JAR files in this folder.

/server

Provides a root folder for Data Grid Server instances.

/static

Contains static resources for Data Grid Console.

12.1.11. Server root directory

Data Grid Server uses infinispan.server.root.path to locate configuration files and data for Data Grid Server instances.

You can create multiple server root folders in the same directory or in different directories and then specify the locations with the -s or --server-root argument, as in the following example:

Unix / Linux

$RHDG_HOME/bin/server.sh -s server2

Windows

$RHDG_HOME\bin\server.bat -s server2

Each server root directory contains the following folders:

├── server
│   ├── conf
│   ├── data
│   ├── lib
│   └── log
FolderDescriptionSystem property override

/server/conf

Contains server configuration files.

infinispan.server.config.path

/server/data

Contains data files organized by container name.

infinispan.server.data.path

/server/lib

Contains server extension files.
This directory is scanned recursively and used as a classpath.

infinispan.server.lib.path
Separate multiple paths with the following delimiters:
: on Unix / Linux
; on Windows

/server/log

Contains server log files.

infinispan.server.log.path

12.1.12. Logging

Configure Data Grid Server logging with the log4j2.xml file in the server/conf folder.

Use the --logging-config=<path_to_logfile> argument to use custom paths, as follows:

Unix / Linux

$RHDG_HOME/bin/server.sh --logging-config=/path/to/log4j2.xml

Tip

To ensure custom paths take effect, do not use the ~ shortcut.

Windows

$RHDG_HOME\bin\server.bat --logging-config=path\to\log4j2.xml