Hazelcast Management Center
Hazelcast Management Center enables you to monitor and manage your cluster members running Hazelcast IMDG. In addition to monitoring the overall state of your clusters, you can also analyze and browse your data structures in detail, update map configurations and take thread dumps from members. You can run scripts (JavaScript, Groovy, etc.) and commands on your members with its scripting and console modules.
You can check Hazelcast IMDG Documentation and Management Center Documentation for more information.
Quick Start
You can launch Hazelcast Management Center by simply running the following command. please check available versions for $MANAGEMENT_CENTER on Docker Store
docker run -p 8080:8080 hazelcast/management-center:$MANAGEMENT_CENTER
Now you can reach Hazelcast Management Center from your browser using the URL http://localhost:8080.
If you are running the Docker image in the cloud, you should use a public IP of your machine instead of localhost.
docker ps and docker inspect <container-id> can be used to find host-ip. Once you find out host-ip, you can browse Hazelcast Management Center using the URL: http://host-ip:8080.
Management Center Default Context Path
Before version 4.0, default context path was /hazelcast-mancenter, so you would access Hazelcast
Management Center by using http://localhost:8080/hazelcast-mancenter. Starting with version 4.0,
it is changed to root context path (i.e. /), so you can access it by using http://localhost:8080.
You can overwrite this default by setting the environment variable MC_CONTEXT_PATH.
Mounting Management Center Home Directory
Management Center uses the file system to store persistent data. However, that is by default inside the docker container and destroyed in case of container restarts. If you want to store Management Center data externally, you need to create a mount to a folder named /data. See the following for how to create a mount point. PATH_TO_PERSISTENT_FOLDER must be replaced by your persistent folder.
docker run -p 8080:8080 -v PATH_TO_PERSISTENT_FOLDER:/data hazelcast/management-center:$MANAGEMENT_CENTER
To provide a license key the system property hazelcast.mc.license can be used (requires version >= 3.9.3):
docker run -e JAVA_OPTS='-Dhazelcast.mc.license=<key>' -p 8080:8080 hazelcast/management-center:$MANAGEMENT_CENTER
Enabling TLS/SSL
To enable TLS/SSL, you need to provide the keystore and expose the default port (8443):
docker run -e JAVA_OPTS='-Dhazelcast.mc.tls.enabled=true -Dhazelcast.mc.tls.keyStore=/keystore/yourkeystore.jks -Dhazelcast.mc.tls.keyStorePassword=yourpassword' -v PATH_TO_KEYSTORE_DIR:/keystore -p 8443:8443 hazelcast/management-center
The default port can be changed by overriding the MC_HTTPS_PORT environment variable. For example, to use port 8444 you can run the following command:
docker run -e MC_HTTPS_PORT=8444 -e JAVA_OPTS='-Dhazelcast.mc.tls.enabled=true -Dhazelcast.mc.tls.keyStore=/keystore/yourkeystore.jks -Dhazelcast.mc.tls.keyStorePassword=yourpassword' -v PATH_TO_KEYSTORE_DIR:/keystore -p 8444:8444 hazelcast/management-center
Please refer to the Management Center documentation for more information on available options.
Hazelcast Member Configuration
For the Hazelcast member configuration and the sample Hello World example, please refer to Hazelcast Docker repository.
Using Custom Logback Configuration File
Management Center can use your custom Logback configuration file. You need to create a mount to a folder named /opt/hazelcast/mc_ext, see the following on how to do it. PATH_TO_PERSISTENT_FOLDER must be replaced with the path to the folder that your custom Logback configuration file resides in. CUSTOM_LOGBACK_FILE must be replaced with the name of your custom Logback configuration file, for example logback-custom.xml.
docker run -e JAVA_OPTS='-Dlogback.configurationFile=/opt/hazelcast/mc_ext/CUSTOM_LOGBACK_FILE' -v PATH_TO_LOCAL_FOLDER:/opt/hazelcast/mc_ext -p 8080:8080 hazelcast/management-center
Starting with an Extra Classpath
You can start the Management Center with an extra classpath entry (for example, when using JAAS authentication) by using the MC_CLASSPATH environment variable:
docker run -e MC_CLASSPATH='/path/to/your-extra.jar' -p 8080:8080 hazelcast/management-center
Enabling Health Check Endpoint
When running the Management Center, you can enable the Health Check endpoint:
docker run -p 8080:8080 -p 8081:8081 -e JAVA_OPTS='-Dhazelcast.mc.healthCheck.enable=true' hazelcast/management-center:$MANAGEMENT_CENTER
This endpoint may be used in container-orchestraction systems, like Kubernetes. Refer to the Management Center documentation for more information.
Customizing container setup
You can make modifications to the container on container startup by defining environment variables.
MC_INIT_CMD: Execute one or more commands separated by semicolons.MC_INIT_SCRIPT: Execute a script in bash syntax in the context of the entry-script. Make this file available by layering to a new container or by assigning a docker volume.
The commands defined by the variables are executed before starting the Management Center in the listed order. You can use this command for example to create an administrative user by defining the following command:
./mc-conf.sh create-user -H=/data -n=admin -p=myPassword11 -r=admin -v
Example:
docker run -ti --name hazelcast-mc \
--env MC_INIT_CMD="./mc-conf.sh create-user -H=/data -n=admin -p=myPassword11 -r=admin -v" \
--rm hazelcast/management-center