Installing Using Docker
Prerequisites
Recommended Docker Version
Apache Ignite 3 is tested on the following Docker configuration:
-
Docker 26.1.3;
-
Docker compose 2.14.2
Docker container environment must follow other system requirements.
Recommended Operating System
Apache Ignite 3 is tested on the following systems:
-
Ubuntu 20.04
-
Ubuntu 22.04
-
CentOS 8
-
RockyLinux 9
-
Mac OS X 14.6
-
Windows 10
Other Linux flavors and newer versions are supported, but may have minor discrepancies in performance or stability.
When running on Linux, the following libraries are also required:
-
GNU C Library (glibc) version 2.29 or newer
-
GNU C Standard Library (libstdc) which supports GLIBCXX_3.4.26 or newer. GLIBCXX_3.4.26 is included with GCC 9.1.0. For more information on version mapping, see the GNU Official Documentation.
Recommended Java Version
Apache Ignite 3 is tested on Oracle JDK 11, 17 and 21. Other Java vendors are supported, but may have minor discrepancies in performance or stability.
Running a Node
Run Apache Ignite in a docker container using the docker run command. Docker will automatically pull the appropriate Apache Ignite version:
docker run -d -p 10300:10300 -p 10800:10800 -p 3344:3344 ignite/ignite3:latest
|
Note
|
If you plan to store persistent data, it is recommended to mount a volume for it. Otherwise, data will be deleted when the container is removed. Consider storing the |
This command launches a single Apache Ignite node. After you run the command, you can check if Apache Ignite is running in the container logs.
Running a Cluster
You can use the docker-compose file to start an entire cluster in docker. You can download a sample docker-compose file and run a 3-node cluster:
-
Download the docker-compose file.
NoteDocker compose version 2.23.1 or later is required to use the provided compose file. -
Download the docker image:
docker pull apache/ignite3:3.1.0 -
Run the docker compose command.
docker compose -f docker-compose.yml up -d
3 nodes will start in Docker and will be available from the CLI tool that can be run locally. Remember to initialise the cluster from the command line tool before working with it.
Running CLI Tool in Docker
|
Note
|
It is not recommended to run the CLI tool in docker. Instead, we recommend to download and install CLI tool locally. |
CLI tool is used to manage Apache Ignite nodes. By default, docker nodes are isolated and run on different networks, so CLI tool will not be able to connect to the target container from another container. To fix that, you need to create a network and add all containers running the nodes to it.
-
Create a new network with the
network createcommand:docker network create ignite-network
-
Add any containers with nodes that are already running to the network:
docker network connect ignite-network {container-id} -
Start the container with the Apache Ignite CLI tool on the same network:
docker run -p 10301:10300 -p 10801:10800 -p 3345:3344 -it --network=ignite-network apache/ignite3:3.1.0 cliTipYou may need to mount configuration or data files. To provide them, mount the files you will use, for example:
+
docker run --rm -it --network=host -v /opt/etc/config.conf:/opt/ignite/etc/ignite-config.conf apache/ignite3:3.1.0 cli
The CLI will be able to connect to the IP address of the node. If you are not sure what the address is, use the container inspect command to check it:
docker container inspect {container-id}
Apache, Apache Ignite, the Apache feather and the Apache Ignite logo are either registered trademarks or trademarks of The Apache Software Foundation.
