Understanding Configuration | Ignite Documentation

Ignite Summit 2023 — Watch on demand — Register now!


Understanding Configuration

This chapter explains different ways of setting configuration parameters in an Ignite cluster. The chapter covers the most ubiquitous approaches for Java and C++ applications.


Configuring .NET, Python, Node.JS and other programming languages

  • .NET developers: refer to the Ignite.NET Configuration section

  • Developers of Python, Node.JS, and other programming languages: use this page to configure your Java-powered Ignite cluster and thin clients section to set up your language-specific applications that will be working with the cluster.


You can specify custom configuration parameters by providing an instance of the IgniteConfiguration class to Ignite when starting the node. You can set the parameters either programmatically or via an XML configuration file. These 2 ways are fully interchangeable.

The XML configuration file is a Spring Bean definition file that must contain the IgniteConfiguration bean. When starting a node from the command line, pass the configuration file as a parameter to the ignite.sh|bat script, as follows:

ignite.sh ignite-config.xml

If you don’t specify a configuration file, the default file {IGNITE_HOME}/config/default-config.xml is used.

Spring XML Configuration

To create a configuration in a Spring XML format, you need to define the IgniteConfiguration bean and set the parameters that you want to be different from the default. For detailed information on how to use XML Schema-based configuration, see the official Spring documentation.

In the example below, we create an IgniteConfiguration bean, set the workDirectory property, and configure a partitioned cache.

<?xml version="1.0" encoding="UTF-8"?>

<beans xmlns="http://www.springframework.org/schema/beans"

    <bean class="org.apache.ignite.configuration.IgniteConfiguration">
        <property name="workDirectory" value="/path/to/work/directory"/>

        <property name="cacheConfiguration">
            <bean class="org.apache.ignite.configuration.CacheConfiguration">
                <!-- Set the cache name. -->
                <property name="name" value="myCache"/>
                <!-- Set the cache mode. -->
                <property name="cacheMode" value="PARTITIONED"/>
                <!-- Other cache parameters. -->

Programmatic Configuration

Create an instance of the IgniteConfiguration class and set the required parameters, as shown in the example below.

IgniteConfiguration igniteCfg = new IgniteConfiguration();
//setting a work directory

//defining a partitioned cache
CacheConfiguration cacheCfg = new CacheConfiguration("myCache");


See the IgniteConfiguration javadoc for the complete list of parameters.

var igniteCfg = new IgniteConfiguration
    WorkDirectory = "/path/to/work/directory",
    CacheConfiguration = new[]
        new CacheConfiguration
            Name = "myCache",
            CacheMode = CacheMode.Partitioned

See the API docs for details.

IgniteConfiguration cfg;

cfg.igniteHome = "/path/to/work/directory";