Get Started with Hazelcast Enterprise

This guide gets you started with Hazelcast Enterprise by explaining installation options, getting a license key, and installing a license key.

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

Step 1. Install Hazelcast Enterprise

Hazelcast Enterprise is available in binary ZIP/TAR files, a Docker image, or a JAR file.

Using the Enterprise Docker Image

  1. Install Docker.

  2. Check that Docker is correctly installed.

    docker version
  3. If you do not see a version number, see the Docker docs for troubleshooting information.

  4. Pull the Hazelcast Docker image from Docker Hub.

    docker pull hazelcast/hazelcast-enterprise:5.0

Using the Enterprise Binary

Download and extract the binaries.

  • Mac

  • Linux

  • Windows

curl 'https://download.hazelcast.com/enterprise/hazelcast-enterprise-5.0.tar.gz' | tar xvzf -
wget 'https://download.hazelcast.com/enterprise/hazelcast-enterprise-5.0.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.

  1. Download and install a supported JDK.

    We recommend installing the AdoptOpenJDK.
  2. Add the following to your pom.xml file.

    <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>
    
    <dependencies>
      <dependency>
        <groupId>com.hazelcast</groupId>
        <artifactId>hazelcast-enterprise</artifactId>
        <version>5.0</version>
      </dependency>
    </dependencies>

Step 2. Get 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.

Step 3. Install 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/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

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 explore the features of Hazelcast Enterprise, see the following: