Installing Hazelcast Enterprise

To install Hazelcast Enterprise, you can use Docker, the binary, or Java. Then, to unlock the Enterprise features, you need to install your Enterprise license key.

Hazelcast Enterprise is a commercial product that offers additional features to the Open Source edition, including the security suite and blue/green deployments for clients. If you’re looking to get started with open source Hazelcast, see Installing Hazelcast Open Source.

Using the Enterprise Docker Image

Install Docker.
Check that Docker is correctly installed.
```
docker version
```
If you do not see a version number, see the Docker docs for troubleshooting information.

Pull the Hazelcast Docker image from Docker Hub.

docker pull hazelcast/hazelcast-enterprise:5.0.5

Using the Enterprise Binary

Download and extract the binaries.

Mac
Linux
Windows

curl -L'https://repository.hazelcast.com/download/hazelcast-enterprise/hazelcast-enterprise-5.0.5.tar.gz' | tar xvzf -

wget -O - 'https://repository.hazelcast.com/download/hazelcast-enterprise/hazelcast-enterprise-5.0.5.tar.gz' | tar xvzf -

Download and extract the Hazelcast ZIP file.

Using the Enterprise JAR

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.

Add the following to your pom.xml file.

<repositories>
    <repository>
        <id>private-repository</id>
        <name>Hazelcast Private Repository</name>
        <url>https://repository.hazelcast.com/release/</url>
        <releases>
            <enabled>true</enabled>
        </releases>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>com.hazelcast</groupId>
        <artifactId>hazelcast-enterprise</artifactId>
        <version>5.0.5</version>
    </dependency>
</dependencies>

Getting an Enterprise License Key

Hazelcast Enterprise requires a license key. You can get a 30-day trial license from the Hazelcast website.

License keys have the following format:

<Hazelcast edition>#<Maximum members>#<License key>

<Hazelcast edition>: Name of the product.
<Maximum members>: Maximum number of members that may use the license at the same time.
<License key>: Machine-readable license key.

The first two strings up to the second hash (#) character are optional. These strings just provide a way for you to know important information about the license key.

For example, both of the following formats are valid:

Full-form license

HazelcastEnterprise#2Nodes#1q2w3e4r5t

Short-form license

1q2w3e4r5t

These licenses are examples and will not work if you install them on members.

Installing a License Key

To use Hazelcast Enterprise, you need to install a license key on your members.

Hazelcast Enterprise license keys are required only for members. You do not need to set a license key for Java clients that are connected to members.

Binary
Docker
Java

Add the following to the hazelcast.xml file in your hazelcast-5.0.5/config directory.

<hazelcast>
    <license-key>Your Enterprise License Key</license-key>
</hazelcast>

Add your license to the HZ_LICENSEKEY environment variable.

docker run -e HZ_LICENSEKEY=<your_license_key> hazelcast/hazelcast-enterprise:5.0.5

Add your license to the setLicenseKey() method.

Config config = new Config();
config.setLicenseKey( "Your Enterprise License Key" );

Next Steps

Complete a tutorial for binary, Docker, or Java to learn the fundamentals of Hazelcast, including:

Starting a cluster
Writing Data to memory
Reading data from memory
Monitoring a cluster with Management Center
Simulating a member failure

If you need more information about managing your license key, see the following resources:

To get started with the Hazelcast Enterprise features, see these tutorials.

To explore the Hazelcast Enterprise features in more detail, see the following: