This guide gets you started with open source Hazelcast by explaining distribution options, application topologies, and installation options.
|Looking for Hazelcast Enterprise? See Get Started with Hazelcast Enterprise.|
Hazelcast is available in two distributions:
Full: Includes Management Center and all connectors for distributed processing
Slim: Excludes Management Center and connectors
These getting started tutorials use the full distribution to walk you through important features.
If you later decide that you do not need these features, you can use the slim version to save memory. For more information about these distributions, see Full and Slim Packages.
You can use Hazelcast in two topologies, depending on where you want the Hazelcast servers (members) to run:
Client/server mode: Hazelcast members run remotely outside of your application, allowing you to scale them independently and connect to them through any of the supported clients.
Embedded mode: Hazelcast members run in the same Java process as your application.
For details about these topologies, see Hazelcast Topologies.
To get started with embedded mode, install Hazelcast in your Java project.
To install the Hazelcast CLI, use one of the following package managers depending on your operating system:
To install the CLI on macOS, use the Homebrew package manager.
brew tap hazelcast/hz brew install hazelcast
To install the CLI on Linux, you can use either of these package managers, depending on your Linux distribution:Debian
wget -qO - https://repository.hazelcast.com/api/gpg/key/public | sudo apt-key add - echo "deb https://repository.hazelcast.com/debian stable main" | sudo tee -a /etc/apt/sources.list sudo apt update && sudo apt install hazelcastRPM
wget https://repository.hazelcast.com/rpm/hazelcast-rpm.repo -O hazelcast-rpm.repo sudo mv hazelcast-rpm.repo /etc/yum.repos.d/ sudo yum install hazelcast
Check that the CLI is installed.
You should see your installed version of Hazelcast:
Download the archive and extract the binaries.
curl 'https://download.hazelcast.com/download.jsp?version=hazelcast-5.0&type=tar&p=' | tar xvzf -
wget 'https://download.hazelcast.com/download.jsp?version=hazelcast-5.0&type=tar&p=' | tar xvzf -
Download and extract the Hazelcast archive for Windows.
Hazelcast runs on Java, which means you can add it as a dependency in your Java project.
The Java package includes both a member API and a Java client API. The member API is for embedded topologies where you want to deploy and manage a cluster in the same Java Virtual Machine (JVM) as your applications. The Java client is for connecting to an existing member in a client/server topology.
Download and install a supported JDK.
We recommend installing the AdoptOpenJDK.
If you’re using Maven, create a new project and add the following to your
<dependencies> <dependency> <groupId>com.hazelcast</groupId> <artifactId>hazelcast</artifactId> <version>5.0</version> </dependency> </dependencies>
If you aren’t using a build tool, download the Hazelcast JAR file and add it to your classpath.