GridGain Developers Hub

GridGain Quick Start Guide for Java

This chapter explains system requirements for running GridGain, how to install GridGain, start a cluster and run a simple Hello World example.

Since GridGain is built on top of Apache Ignite, GridGain reuses Ignite’s system properties, environment properties, startup scripts, etc. wherever possible.


GridGain was officially tested on:


Oracle JDK 8, 11 or 17, Open JDK 8, 11 or 17, IBM JDK 8, 11 or 17


Linux (any flavor), Mac OSX (10.6 and up), Windows (XP and up), Windows Server (2008 and up), Oracle Solaris, z/OS


x86, x64, SPARC, PowerPC


No restrictions (10G recommended)

If you use Java version 11 or later, Running GridGain with Java 11 or later for details.

(Optional) Open Ports

Depending on your environment and what your plan is, you may want to open additional ports. GridGain uses the following ports:

  • 47100-47200 — ports used by GridGain nodes to communicate. Specific ports used depend on node configuration.

  • 47500-47600 — ports used by GridGain nodes to discover other nodes in the network. Specific ports used depend on node configuration.

  • 10800 — the port used for thin clients, JDBC and ODBC connections.

  • 8080 — the port used for REST API.

  • 11211 — the port used by control script calls. This port should only be opened on nodes that need to send control script messages to other nodes.

Installing GridGain

GridGain is available in three editions: Community Edition (CE), Enterprise Edition (EE) and Ultimate Edition (UE). For this example, we’ll use the GridGain CE, which is distributed as binary, docker, and cloud images, and via RPM/DEB. This chapter explains how to install the GridGain CE binary distribution.

To get started with the GridGain CE binary distribution:

  1. Download the GridGain binary as a zip archive.

  2. Unzip the zip archive into the installation folder in your system.

  3. Move the ignite-rest-http folder from {gridgain}/libs/optional to {gridgain}/libs to enable the Ignite REST library for the cluster. The library is used by GridGain Nebula for cluster management and monitoring needs.

  4. (Optional) Enable required modules.

  5. (Optional) Set the IGNITE_HOME environment variable or Windows PATH to point to the installation folder and make sure there is no trailing / (or \ for Windows) in the path.

Starting a GridGain Node

You can start a GridGain node from the command line using the default configuration or by passing a custom configuration file. You can start as many nodes as you like and they will all automatically discover each other.

Navigate into the bin folder of GridGain installation directory from the command shell. Your command might look like this:

cd {gridgain}/bin/
cd {gridgain}\bin\

Start a node with a custom configuration file that is passed as a parameter to|bat like this:

./ ../examples/config/example-ignite.xml
ignite.bat ..\examples\config\example-ignite.xml

You will see output similar to this:

[08:53:45] Ignite node started OK (id=7b30bc8e)
[08:53:45] Topology snapshot [ver=1, locNode=7b30bc8e, servers=1, clients=0, state=ACTIVE, CPUs=4, offheap=1.6GB, heap=2.0GB]

Open another tab from your command shell and run the same command again:

./ ../examples/config/example-ignite.xml
ignite.bat ..\examples\config\example-ignite.xml

Check the Topology snapshot line in the output. Now you have a cluster of two server nodes with more CPUs and RAM available cluster-wide:

[08:54:34] Ignite node started OK (id=3a30b7a4)
[08:54:34] Topology snapshot [ver=2, locNode=3a30b7a4, servers=2, clients=0, state=ACTIVE, CPUs=4, offheap=3.2GB, heap=4.0GB]

Running Your First GridGain Application

Once the cluster is started, follow the steps below to run a simple HelloWorld example.

1. Add Maven Dependency

The easiest way to get started with GridGain in Java is to use Maven dependency management.

Create a new Maven project with your favorite IDE and add the following dependencies in your project’s pom.xml file.


        <id>GridGain External Repository</id>



Here is a sample file that prints 'Hello World' and some other environment details on all the server nodes of the cluster. The sample shows how to prepare a cluster configuration with Java APIs, create a sample cache with some data in it, and execute custom Java logic on the server nodes.

public class HelloWorld {
    public static void main(String[] args) throws IgniteException {
        // Preparing IgniteConfiguration using Java APIs
        IgniteConfiguration cfg = new IgniteConfiguration();

        // The node will be started as a client node.

        // Classes of custom Java logic will be transferred over the wire from this app.

        // Setting up an IP Finder to ensure the client can locate the servers.
        TcpDiscoveryMulticastIpFinder ipFinder = new TcpDiscoveryMulticastIpFinder();
        cfg.setDiscoverySpi(new TcpDiscoverySpi().setIpFinder(ipFinder));

        // Starting the node
        Ignite ignite = Ignition.start(cfg);

        // Create an IgniteCache and put some values in it.
        IgniteCache<Integer, String> cache = ignite.getOrCreateCache("myCache");
        cache.put(1, "Hello");
        cache.put(2, "World!");

        System.out.println(">> Created the cache and add the values.");

        // Executing custom Java compute task on server nodes.
        ignite.compute(ignite.cluster().forServers()).broadcast(new RemoteTask());

        System.out.println(">> Compute task is executed, check for output on the server nodes.");

        // Disconnect from the cluster.

     * A compute tasks that prints out a node ID and some details about its OS and JRE.
     * Plus, the code shows how to access data stored in a cache from the compute task.
    private static class RemoteTask implements IgniteRunnable {
        Ignite ignite;

        @Override public void run() {
            System.out.println(">> Executing the compute task");

                "   Node ID: " + ignite.cluster().localNode().id() + "\n" +
                "   OS: " + System.getProperty("") +
                "   JRE: " + System.getProperty(""));

            IgniteCache<Integer, String> cache = ignite.cache("myCache");

            System.out.println(">> " + cache.get(1) + " " + cache.get(2));

3. Run

Run You will see 'Hello World!' and other environment details printed on all the server nodes.

Next Steps

From here, you may want to:

Further Examples

Your GridGain installation includes additional examples. These examples are shipped together with the primary GridGain package you downloaded as part of the GridGain installation above.

To run the examples project please follow these steps (which are provided for IntelliJ IDEA IDE, but should apply to similar IDEs such as Eclipse):

  1. Start IntelliJ IDEA, click the "Import Project" button:

    Importing a Project in IntelliJ
  2. Navigate to the {gridgain}/examples folder and select the {gridgain}/examples/pom.xml file. Click "OK".

  3. Click "Next" on each of the following screens and apply the suggested defaults to the project. Click "Finish".

  4. Wait while IntelliJ IDEA finishes setting up Maven, resolving dependencies, and loading modules.

  5. Set up JDK if needed.

  6. Run src/main/java/org.apache.examples/datagrid/CacheApiExample:

    Run a project in IntelliJ
  7. Make sure that the example has been started and executed successfully, as shown in the image below.

    Project in IntelliJ

Running GridGain with Java 11 or Later

To run GridGain with Java 11 or later:

  • Set the JAVA_HOME environment variable to point to the Java installation directory.

  • Pass specific flags to JVM to make proprietary SDK APIs available. These APIs If you use the start-up script (or ignite.bat for Windows), you do not need to do anything because these flags are already set up in the script. Otherwise, provide the following parameters to the JVM of your application: