GridGain Developers Hub
GitHub logo GridGain iso GridGain.com
GridGain Software Documentation

Installing Using Docker

Considerations

In-memory vs Persistent Cluster

When deploying a persistent GridGain cluster, you should always mount a persistent volume or local directory. If you do not use a persistent volume, GridGain will store the data in the container’s file system. It means that the data will be erased when you remove the container. To save the data in a permanent location, mount a persistent volume.

Networking

By default, GridGain docker image exposes the following ports: 11211 47100 47500 49112. Expose more ports as needed by adding -p <port> to the docker run command. For example, to connect a thin client to the node running inside a docker container, open port 10800:

docker run -d -p 10800:10800 gridgain/community

Downloading GridGain Docker Image

Assuming that you already have Docker installed on your machine, you can pull and run a GridGain Docker image using the following commands.

Open a command shell and use the following command to pull a GridGain Docker image.

# Pull latest version
sudo docker pull gridgain/community

By default, the latest version is downloaded but you can download a specific version too.

# Pull specific GridGain version
sudo docker pull gridgain/community:8.7.8

For GridGain Enterprise Edition or GridGain Ultimate Edition, use gridgain/enterprise or gridgain/ultimate.

Running In-Memory Cluster

Run Gridgain in a docker container using the docker run command.

# Run latest version
sudo docker run -d gridgain/community

This command will launch a single GridGain node.

To run a specific version of GridGain, use the following command:

# Run specific GridGain version
sudo docker run -d gridgain/community:8.7.8

For GridGain Enterprise Edition or GridGain Ultimate Edition, use gridgain/enterprise or gridgain/ultimate.

# Run GridGain Ultimate Edition
sudo docker run -d \
  -e "LICENCE_URL=$LICENCE_URL" \
  gridgain/ultimate:8.7.8

Running Persistent Cluster

If you use Native Persistence, GridGain will store the user data under the default work directory ({IGNITE_HOME}/work) in the file system of the container. This directory will be erased if you restart the docker container. To avoid this, you can:

  • use a persistent volume to store the data; or

  • mount a local directory.

These two options are described in the following sections.

Using Persistent Volume

To create a persistent volume, run the following command:

sudo docker volume create persistence-volume

We will mount this volume to a specific directory when running the GridGain docker image. This directory will have to be passed to GridGain. This can be done in two ways:

  • Using the IGNITE_WORK_DIR system property.

  • In the node configuration file.

The following command launches the GridGain Docker image and passes the work directory to GridGain via the system property:

docker run -d \
  -v persistence-volume:/persistence \
  -e IGNITE_WORK_DIR=/persistence \
  gridgain/community

Using Local Directory

Instead of creating a volume, you can mount a local directory to the container in which the GridGain image is running and use this directory to store persistent data. When restarting the container with the same command, GridGain will load the data from the directory.

mkdir work_dir

docker run -d \
  -v ${PWD}/work_dir:/persistence \
  -e IGNITE_WORK_DIR=/persistence \
  gridgain/community

The -v option mounts a local directory under the /persistence path in the container. The -e IGNITE_WORK_DIR=/persistence option tells GridGain to use this folder as the work directory.

Providing Configuration File

When you run the image, it starts a node with the default configuration file. You can pass a custom configuration file by using the CONFIG_URI environment variable:

docker run -d \
  -e CONFIG_URI=http://myserver/config.xml  \
  gridgain/community

You can also use a file from you local file system. You need to mount the file first under a specific path inside the container by using the -v option. Then, use this path in the CONFIG_URI option:

docker run -d \
  -v /local/dir/config.xml:/config-file.xml \
  -e CONFIG_URI=/config-file.xml \
  gridgain/community

Enabling Modules

To enable specific modules, specify their names in the "OPTION_LIBS" system variable as follows:

sudo docker run -d \
  -e "OPTION_LIBS=ignite-rest-http,ignite-aws" \
  gridgain/community

By default, GridGain Docker image starts with the following modules enabled:

  • ignite-log4j,

  • ignite-spring,

  • ignite-indexing.

Environment Variables

The following parameters can be passed as environment variables in the docker container:

Parameter Name Description Default

CONFIG_URI

URL to the GridGain configuration file (can also be relative to the META-INF folder on the class path). The downloaded config file will be saved to ./ignite-config.xml

N/A

OPTION_LIBS

A list of modules that will be enabled for the node.

ignite-log4j, ignite-spring, ignite-indexing

JVM_OPTS

JVM arguments passed to the GridGain instance.

N/A

EXTERNAL_LIBS

A list of URL’s to external libs.

N/A

LICENCE_URL

An url to a licence file. A licence is required when you run the GridGain Ultimate or Enterprise Editions.

N/A