Apache Ignite Documentation

GridGain Developer Hub - Apache Ignitetm

Welcome to the Apache Ignite developer hub run by GridGain. Here you'll find comprehensive guides and documentation to help you start working with Apache Ignite as quickly as possible, as well as support if you get stuck.


GridGain also provides Community Edition which is a distribution of Apache Ignite made available by GridGain. It is the fastest and easiest way to get started with Apache Ignite. The Community Edition is generally more stable than the Apache Ignite release available from the Apache Ignite website and may contain extra bug fixes and features that have not made it yet into the release on the Apache website.


Let's jump right in!


Documentation     Ask a Question     Download


Javadoc     Scaladoc     Examples

Docker Deployment

Deploy Ignite within Docker containers.

Docker allows packaging Ignite deployment with all the dependencies into a standard container. Docker automates downloading the Ignite release, deploying users' library into Ignite, and configuring nodes. It also automatically starts up a fully configured Ignite node. Such integration allows users to deploy new code by simply restarting the Ignite docker container.

Start Ignite Docker Container

For running a docker container, you need to pull and start a docker image. By default, the latest version is downloaded. You can see a full list of tags here.

To pull the Ignite docker container, use the following command:

# Pull latest version.
sudo docker pull apacheignite/ignite

# Pull ignite version {ignite-version}
sudo docker pull apacheignite/ignite:{ignite-version}

To run Ignite docker container using docker run, use the following command:

# Run latest version.
sudo docker run -it --net=host 

# Run ignite version {ignite-version}
sudo docker run -it --net=host 

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



URL to the Ignite 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




Ignite optional libs which will be included in the class path.


ignite-aws, ignite-aop


Environment variables passed to the Ignite instance in your docker command.


-Xms1g -Xmx1g -server -XX:+AggressiveOpts -XX:MaxPermSize=256m


To run Ignite docker container, use the following command:

sudo docker run -it --net=host -e "CONFIG_URI=https://raw.githubusercontent.com/apache/ignite/master/examples/config/example-cache.xml" apacheignite/ignite

You should see the following in the logs:

Docker Deployment

Deploy Ignite within Docker containers.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.