This is a prerelease version.

View latest

Installing and Starting Management Center

6.0-SNAPSHOT 5.6 5.5.2 5.5 5.4.1 5.4 5.3.4 5.3 5.2 5.1 5.0

You can install Management Center, using Docker, a package manager, or the binary distribution.

Before you Begin

Review the requirements and make sure that you meet them.

Using Docker

Deploying via Docker is a convenient way to evaluate the latest version of Management Center:

  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 Management Center Docker image from Docker Hub.

    docker pull hazelcast/management-center:latest

  5. Start the Management Center service

    docker run --rm -p 8080:8080 hazelcast/management-center:latest

In some cases, such as querying maps that contain custom objects, you may need to add those object classes to the classpath of Management Center before starting it. To add your own classes to the classpath, you can do one of the following:

  • Pass the MC_CLASSPATH environment variable the paths to your classes, separated by a semicolon.

  • Put your classes in the bin/user-lib/ directory, and mount that directory to the Docker container.

You can find more details on DockerHub.

Using a Package Manager

Hazelcast offers package managers for Linux and Mac operating systems.

  1. To install Management Center, use one of the following methods, depending on your operating system:

    • Mac

    • Linux

    • Windows

    To install on macOS, use the Homebrew package manager.

    brew tap hazelcast/hz
brew install hazelcast-management-center@5.5.2

    To install 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 snapshot main" | sudo tee -a /etc/apt/sources.list
sudo apt update && sudo apt install hazelcast-management-center
    RPM
    wget https://repository.hazelcast.com/rpm/snapshot/hazelcast-rpm.repo -O hazelcast-snapshot-rpm.repo
sudo mv hazelcast-snapshot-rpm.repo /etc/yum.repos.d/
sudo yum install hazelcast-management-center

    At the moment, Management Center does not support any Windows package managers.

    To get started with Management Center on Windows, use one of the other available installation options.

  2. Check that Management Center is installed.

    hz-mc -V

    You should see the version of Management Center.

For more information about the package manager, see the GitHub repository.

Using Binary Packages

Hazelcast Management Center is included in the Hazelcast Platform download package.

When a new version of Hazelcast Platform is released, it comes with a compatible version of Management Center. You can download Hazelcast Platform from the download page of the Hazelcast website.

If a new version of Management Center is released before a new version of Hazelcast Platform, you can download the new version as a separate package from the download page.

To start Management Center from the binary package, you should use the scripts that come with the download package.

You cannot use Management Center as a library. Management Center runs as a standalone web application.

You can preconfigure a cluster connection 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.

The recommended way to start Management Center with the binary package is the built-in start scripts in the bin/ directory. A script is available as a batch file for Windows or a shell script for Mac and Linux.

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

  • Linux and Mac

  • Windows

hz-mc start
mc-start.cmd

Providing an Extra Classpath

In some cases, such as querying maps that contain custom objects, you may need to add those object classes to the classpath of Management Center before starting it. To add your own classes to the classpath, you can do one of the following:

  • Pass the MC_CLASSPATH environment variable the paths to your classes, separated by semicolons.

  • Put your classes in the bin/user-lib/ directory.

  • Linux and Mac

  • Windows

export MC_CLASSPATH="/path/to/an/extra.jar:/path/to/an/otherextra.jar"
hz-mc start
SET MC_CLASSPATH="/path/to/an/extra.jar;/path/to/an/otherextra.jar"
mc-start.cmd

Stopping Management Center via command line

The following command stops all Management Center processes that are started with either hz-mc start or mc-start.cmd commands:

  • Linux and Mac

  • Windows

hz-mc stop
mc-stop.cmd
These commands stop Management Center processes that have exactly the same version as the script. If you have multiple versions of Management Center running, you need to stop each version using its corresponding script.

Snapshot versions

Development versions of an upcoming release are available as snapshots. To use the most recent snapshot version of Management Center, use the following:

  • Docker:

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

  • Binary packages:

  • Package managers:

    • Homebrew

      brew tap hazelcast/hz
brew install hazelcast-management-center@6.0.0-SNAPSHOT

    • Linux

      Debian
      wget -qO - https://repository.hazelcast.com/api/gpg/key/public | sudo apt-key add -
echo "deb https://repository.hazelcast.com/debian snapshot main" | sudo tee -a /etc/apt/sources.list
sudo apt update && sudo apt install hazelcast-management-center
      RPM
      wget https://repository.hazelcast.com/rpm/snapshot/hazelcast-rpm.repo -O hazelcast-snapshot-rpm.repo
sudo mv hazelcast-snapshot-rpm.repo /etc/yum.repos.d/
sudo yum install hazelcast-management-center

When you use a snapshot version, it can be useful to query the build information to be able to tell what revision you are using. You can find version metadata about a running instance of Management Center at the following endpoint: <hazelcast.mc.home>/api/buildInfo. This endpoint returns JSON.

Next Steps

For an end-to-end getting started, see Get Started with Management Center Using Docker Compose.

To learn how to connect to a cluster, see Cluster Connections.

To serve Management Center over HTTPS instead of HTTP, see Serve Management Center over HTTPS.

For the options you can provide when starting Management Center, see System Properties and Environment Variables.

Enterprise topics

To explore the licensed features of Management Center, see the following:

See also the following for the Management Center features that rely on your cluster’s enterprise capabilities:

lifebuoy

Help and support