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

Google Compute Deployment

Deploy Ignite on Google Compute.

The Apache Ignite image allows you to set up and quickly deploy a simple Apache Ignite cluster using the Google Compute Console.

Google Compute Deployment

  1. To import the Ignite Image, execute the following command:
gcloud compute images create ignite-image \
   --source-uri gs://ignite-media/ignite-google-image.tar.gz

For more information, please refer to cloud.google.com.

  1. Go to Google Compute Console.
  2. Go to Compute->Compute Engine->VM instances and click on New instance.
  3. Click the Change button in section Boot disk.
  4. Go to Custom images and choose the imported image. In the screenshot below, you can see an image named ignite-name.
  1. Click on Management, disk, networking, access & security options and 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 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 figure below:


Preferred Ignite Version

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

  1. Fill in the required fields and run instances.
  2. Connect to the instances.
  3. To access the execution progress you need to know a container id. The following command will show the container id:
sudo docker ps
  1. The following command will show the logs:
sudo docker logs -f CONTAINER_ID
  1. Use the following command to enter the docker container:
sudo docker exec -it container_id /bin/bash

Updated about a year ago

Google Compute Deployment

Deploy Ignite on Google Compute.

Suggested Edits are limited on API Reference Pages

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