GridGain Developers Hub

Installing Using ZIP Archive

Prerequisites

GridGain is tested on the following systems:

  • Ubuntu 20.04

  • Ubuntu 22.04

  • CentOS 8

  • RockyLinux 9

  • Mac OS X 14.6

  • Windows 10

Other Linux flavors and newer versions are supported, but may have minor discrepancies in performance or stability.

When running on Linux, the following libraries are also required:

  • GNU C Library (glibc) version 2.29 or newer

  • GNU C Standard Library (libstdc) which supports GLIBCXX_3.4.26 or newer. GLIBCXX_3.4.26 is included with GCC 9.1.0. For more information on version mapping, see the GNU Official Documentation.

GridGain is tested on Oracle JDK 11, 17 and 21. Other Java vendors are supported, but may have minor discrepancies in performance or stability.

GridGain Package Structure

The GridGain provides 2 archives for the distribution:

  • gridgain9-db-9.1.8 - this archive contains everything related to the GridGain database, and when unpacked, the folder where data will be stored by default. You start GridGain nodes from this folder.

  • gridgain9-cli-9.1.8 - this archive contains the GridGain CLI tool. This tool is the main way of interacting with GridGain clusters and nodes.

Installing GridGain Database

To install the GridGain database, download the database archive from the website and then:

  1. Unpack the archive:

    unzip gridgain9-db-9.1.8.zip && cd gridgain9-db-9.1.8
    Expand-Archive gridgain9-9.1.8.zip -DestinationPath . ; cd gridgain9-db-9.1.8
    unzip -xf gridgain9-db-9.1.8.zip & cd gridgain9-db-9.1.8
  2. Create the GRIDGAIN_HOME environment variable with the path to the gridgain9-db-9.1.8 folder.

Starting the Node

Once you have unpacked the archive, you can start the GridGain node:

bin/gridgain9db

By default, the node loads the etc/gridgain-config.conf configuration file on startup. You can update it to customize the node configuration, or change the configuration folder in the etc/vars.env file.

When the node is started, it will enter the cluster if it is already configured and initialized, or will wait for cluster initialization.

Installing GridGain CLI Tool

The CLI tool is the primary means of working with the GridGain database. It is not necessary to install on every machine that is running GridGain, as you can connect to the node via REST interface.

To install the GridGain CLI, download the database archive from the website and then unpack it:

unzip gridgain9-cli-9.1.8.zip && cd gridgain9-cli-9.1.8
Expand-Archive gridgain9-cli-9.1.8.zip -DestinationPath . ; cd gridgain9-cli-9.1.8
unzip -xf gridgain9-cli-9.1.8.zip & cd gridgain9-cli-9.1.8

Next Steps

With the GridGain installed, you can proceed with the Getting Started or use the available APIs immediately.