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

AWS Deployment

Deploy Ignite within AMI images

The Apache Ignite AMI (Amazon Machine Image) allows you to set up and quickly deploy a simple Apache Ignite cluster using the Amazon Web Services EC2 Management Console.

Amazon EC2 Deployment

  1. Choose the required region and click on the link in the table below




or search the image in Community AMIs by using Apache Ignite keyword:

  1. Choose an Instance Type.
  2. Go to Configure Instance and expand the Advanced Details section.
  3. Add any of the following configuration parameters:


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


https://raw.githubusercontent.com/apache/ignite/ master/examples/config/example-cache.xml


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

ignite-log4j, ignite-spring, ignite-indexing



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


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


List of URL's to libs.




Version of Apache Ignite



as shown in the image below:

Preferred Ignite Version

The IGNITE_VERSION attribute can vary depending on the Apache Ignite version of interest.

  1. On the Tag Instance, set the value for Name tag. For example ignite-node.
  2. Review and run instances.
  3. Connect to the instances http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AccessingInstances.html.
  4. To access the execution progress, you need to know the container id. Use the following command:
sudo docker ps
  1. Show logs:
sudo docker logs -f CONTAINER_ID
  1. Enter the docker container:
sudo docker exec -it container_id /bin/bash

Updated about a year ago

AWS Deployment

Deploy Ignite within AMI images

Suggested Edits are limited on API Reference Pages

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