GridGain Developers Hub

Installing Using ZIP Archive

Prerequisites

This section describes the platform requirements for machines running GridGain. GridGain system requirements scale depending on the size of the cluster.

JDK

11 and later

OS

Linux (Debian and Red Hat flavours), Windows 10 or 11

ISA

x86 or x64

GridGain Package Structure

The GridGain provides 2 archives for the distribution:

  • gridgain9-db-9.0.10 - 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.0.10 - 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.0.10.zip && cd gridgain9-db-9.0.10
    Expand-Archive gridgain9-9.0.10.zip -DestinationPath . ; cd gridgain9-db-9.0.10
    unzip -xf gridgain9-db-9.0.10.zip & cd gridgain9-db-9.0.10
  2. Create the GRIDGAIN_HOME environment variable with the path to the gridgain9-db-9.0.10 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.0.10.zip && cd gridgain9-cli-9.0.10
Expand-Archive gridgain9-cli-9.0.10.zip -DestinationPath . ; cd gridgain9-cli-9.0.10
unzip -xf gridgain9-cli-9.0.10.zip & cd gridgain9-cli-9.0.10

Next Steps

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