This is a prerelease version.

View latest

Getting Started

Management Center via Docker

The easiest way to start using Management Center is to run the official Management Center Docker image.

docker run --rm -p 8080:8080 hazelcast/management-center:5.1-SNAPSHOT

Please see more details at DockerHub.

Downloading Management Center

To start using the Management Center without Docker:

  1. Download the Hazelcast Management Center package.

  2. Start the Management Center service.

  3. Launch the Management Center user interface.

Hazelcast Management Center is included in the Hazelcast download package. You can download it from the download page of the Hazelcast website.

When a new version of Hazelcast is released, it comes with a compatible version of Management Center.

There may be times when a new Management Center version is released before a new version of Hazelcast. In that case, you may download the new Management Center from its download page as a separate package.

Using SNAPSHOT versions

If you need to use the most recent development version of Management Center, then you can run it by using the latest-snapshot tag in Docker:

docker run --rm -p 8080:8080 --pull=always hazelcast/management-center:latest-snapshot

In these cases, it can be useful to query the build information to be able to tell what revision are you using.

Getting Build Information

You can find version metadata about a running instance of Management Center at the following endpoint: {mc-base-url}/api/buildInfo.

This endpoint returns JSON.

Starting the Management Center Service

You have the following options to start the Management Center service:

  • Start Hazelcast Management Center from the command line.

  • Use the scripts that come with the download package.

  • Deploy the file hazelcast-management-center-5.1-SNAPSHOT.war on your Java application server/servlet container.

For all the starting options you can preconfigure a cluster in Management Center by setting the following environment variables:

  • MC_DEFAULT_CLUSTER_MEMBERS variable should contain a comma-separated list of the cluster member addresses.

  • MC_DEFAULT_CLUSTER variable should contain the cluster name and defaults to dev if not provided.

Using the Command Line

Extract the Hazelcast or Management Center package. The extracted directory, i.e., hazelcast-management-center-5.1-SNAPSHOT, contains the hazelcast-management-center-5.1-SNAPSHOT.jar file.

You can start this file directly from the command line using the following command:

java -jar hazelcast-management-center-5.1-SNAPSHOT.jar

The above command starts the Hazelcast Management Center service on port 8080 with the root context path (http://localhost:8080).

You can use -Dhazelcast.mc.http.port and -Dhazelcast.mc.contextPath command line options to start Management Center on a different port and context path:

java -Dhazelcast.mc.http.port=8083 -Dhazelcast.mc.contextPath='hazelcast-mc' -jar hazelcast-management-center-5.1-SNAPSHOT.jar

The above command starts Management Center on port 8083 and context path hazelcast-mc. You can access it by opening http://localhost:8083/hazelcast-mc in your browser.

The next step is to let Management Center know the Hazelcast cluster member addresses as explained in the Connecting to the Clusters chapter.

For the options you can provide when starting with the command line, see Configuring Management Center. For example, you can learn about topics including how to start with a license or extra classpath, how to configure the security, disk usage, update interval or logging.

Deploying to Application Server

Instead of starting at the command line, you can deploy the Management Center to your application server (Tomcat, Jetty, etc.).

Using Scripts in the Package

As another option, you can use the start.bat or start.sh scripts, which come with the download package in bin/ folder, to start the Management Center. You can find these scripts under the extracted directory.

Quick Launch

After the above steps are completed, let’s quickly open Management Center with the default settings.

Assuming that you have started your Hazelcast clusters each including a single member on your local machine (localhost) and started the Management Center service on http://localhost:8080, follow the below instructions:

  1. Go to http://localhost:8080 using your preferred browser. +. Select Dev Mode as the security provider, and click Enable (note: this configuration is not recommended for production environments as it skips the requirement for login credentials)

  2. This will take you to the Cluster Connections page. Click on the blue + button to define the connection Management Center will use to your Hazelcast cluster:

    1. Fill in the Cluster Name (this needs to be an exact match. dev is the default Cluster name)

    2. Fill in one or more of the members' address details. If the cluster is running on your laptop, then this will be localhost.

    3. Click on the Connect button to save the configuration and connect to the cluster.

  3. On the Cluster Connections page, click the View Cluster button to go to that cluster’s dashboard as shown below:

Dashboard

See the Hazelcast documentation for information on starting Hazelcast clusters.

Further details on the Dev Mode option for development or evaluation purposes that provides quick access to Management Center without requiring any security credentials, see the Dev Mode section for details.