Table of Contents

• Hazelcast Quick Start
• Hazelcast Enterprise Quick Start
• Hazelcast Docker Repositories
• Hazelcast Defined Environment Variables
• Using Custom Hazelcast Configuration File
• Extending Hazelcast Base Image
• Stopping a Hazelcast Member
• Hazelcast Docker Files

Hazelcast Quick Start

You can launch Hazelcast Docker Container by running the following command. You can find the full list of Hazelcast versions to replace $HAZELCAST_VERSION at Official Hazelcast Docker Hub.

docker run -ti hazelcast/hazelcast:$HAZELCAST_VERSION

This command will pull Hazelcast Docker image and run server.sh to start a new Hazelcast Instance.

Hazelcast Enterprise Quick Start

You can launch Hazelcast Enterprise Docker Container by running the following command. You can find the full list of Hazelcast Enterprise versions to replace $HAZELCAST_VERSION at Official Hazelcast Docker Hub.

please contact sales@hazelcast.com for trial license.

docker run -ti -e HZ_LICENSE_KEY=YOUR_LICENSE_KEY hazelcast/hazelcast-enterprise:$HAZELCAST_VERSION

Hazelcast Docker Repositories

You can find all Hazelcast Docker Images on Docker Store Hazelcast Page. https://store.docker.com/profiles/hazelcast

Hazelcast Defined Environment Variables

You can give environment variables to the Hazelcast member within your Docker command. Currently, we support the variables MIN_HEAP_SIZE and MAX_HEAP_SIZE inside our start script. An example command is as follows:

docker run -e MIN_HEAP_SIZE="1g" -ti hazelcast/hazelcast

You can also define your environment variables inside a file as shown in the following example command:

docker run --env-file <file-path> -ti hazelcast/hazelcast

As shown below, you can use JAVA_OPTS environment variable if you need to pass multiple VM arguments to your Hazelcast member.

docker run -e JAVA_OPTS="-Xms512M -Xmx1024M" -ti hazelcast/hazelcast

Using Custom Hazelcast Configuration File

If you need to configure with your own hazelcast.xml or jar files with your own domain classes, you need to mount the folder that has those files. Also, while running the Docker image, you need to pass the hazelcast.xml file path to hazelcast.config in JAVA_OPTS parameter. Please see the following example:

docker run -e JAVA_OPTS="-Dhazelcast.config=/opt/hazelcast/config_ext/hazelcast.xml" -v PATH_TO_LOCAL_CONFIG_FOLDER:/opt/hazelcast/config_ext -ti hazelcast/hazelcast

Extending Hazelcast Base Image

You can use Hazelcast Docker Image to start a new Hazelcast member with default configuration. If you like to customize your Hazelcast member, you can extend the Hazelcast base image, provide your own configuration file and customize your initialization process. In order to do that, you need to create a new Dockerfile and build it with docker build command.

In the Dockerfile example below, we are creating a new image based on the Hazelcast image and adding our own configuration file from our host to the container, which is going to be used with Hazelcast when the container runs.

FROM hazelcast/hazelcast:$HAZELCAST_VERSION
# Add your custom hazelcast.xml
ADD hazelcast.xml $HZ_HOME
# Run hazelcast
CMD ./server.sh

After creating the Dockerfile you need to build it by running the command below:

docker build .

Now you can run your own container with its ID or tag (if you provided -t option while building the image) using the docker run command.

Stopping a Hazelcast Member

You can stop the member using the script stop.sh. For this purpose, you need to run the following command to the running Docker container:

docker exec -it "id of running container" /opt/hazelcast/stop.sh

You can check the logs thereafter using the following command:

docker logs "id of running container"

Hazelcast Docker Files

You can find docker files by going corresponding hazelcast-docker repo tag. See the full list here: https://github.com/hazelcast/hazelcast-docker/releases