GridGain Developers Hub

Cluster Management Screen

On the Cluster Management screen, you can view a list of the clusters that are registered in Control Center. To access this screen, select Cluster Management from the user profile menu.

On this screen, you can add, remove, activate, and deactivate clusters, as well as share clusters with teams and users.

Cluster Management screen

The following information is available on the cluster list:

Column Description


The name of the cluster. See Cluster Name.

Last seen

The last time that the cluster was connected to Control Center.


Indicates whether the cluster is connected to Control Center.

Baseline Size

The number of nodes that are registered in the baseline topology.

Client Nodes

The number of client nodes.

Server Nodes

The number of server nodes.


The product edition that the cluster uses (either GridGain edition or Apache Ignite).


The version of the product.


Indicates whether the cluster is secured by authentication.

Some additional information about the "current" cluster (selected on the list) is shown in the Cluster Info widget at the bottom of teh screen,

To view more information about the "current" (selected) cluster on the My Cluster screen, select Dashboard from the navigation menu.

Cluster Name

Every cluster is identified by a name. When a cluster starts for the first time, the cluster’s default name is generated automatically.

GridGain users can change a cluster’s name by using the control script. See Cluster Name.

The name of the current cluster is displayed in the top-right corner:

Custer name

Switching Between Clusters

If multiple clusters are registered in Control Center, you can switch between clusters by using the Select Cluster control at the top of the screen.

Adding Clusters

When a cluster connects to Control Center, it prints an auto-generated token to the console of the coordinator node. You use this token to register the cluster in Control Center. Tokens are single use and expire after 5 minutes. Once a token is registered in a Control Center instance, it becomes invalid. You will need to generate a new token if you want to register the cluster again.

To add a cluster:


  2. If you attach Apache Ignite, make sure to switch to Apache Ignite in the wizard.

  3. Paste the token into the dialog and click OK.

  4. The wizard will confirm that the cluster was found and attached.

If your cluster is protected by authentication, you will be asked to enter the username and password.

Downloading Cluster Logs

To download cluster logs for a specific date, click ⋮ and select Download logs. In the Cluster logs dialog that opens, select a date and click Get logs.

A progress bar appears. Once the log package is ready, it automatically downloaded to your machine. If the download does not start automatically, click Download io the Cluster logs dialog.

Generating a Token

To generate a token, use the management script:

./ --token
./management.bat --token

Activating and Deactivating Clusters

The Status column indicates whether a cluster is or isn’t active. To activate or deactivate a cluster, click the icon and, from the menu, select Activate or Deactivate.

Sharing Clusters

You can have access to a cluster as:

  • User - a regular user who can view the cluster that had been shared with them individually or via a team, as well as utilize the actions that appear in the cluster’s context menu.

  • Owner - the user who had created or attached the cluster. Owners have extended cluster access rights, including sharing the cluster with teams or users, suspension, removal, etc.

As a cluster owner, you can share that cluster with individual users and/or teams. You use the Teams screen to create and manage teams.

Sharing with Users and Teams

To share a cluster you have created or attached with individual users and/or teams, click by that cluster’s name on the list and select Share. The Share Cluster dialog opens.

Share Cluster dialog

The dialog lists users and teams that already have access to the cluster.

In the entry field across the top of the Share Cluster dialog, start typing a Control Center user’s email, an LDAP ID, or a team name. As you type, the incremental search mechanism displays suggestions in a drop-down list. Select one of the suggested users or teams. Alternatively, type the identifier to the end, then click [Enter]. You can add multiple users and/or teams in a single operation. When done, click Share.

The users and teams you have entered appear in the corresponding sections of the Share Cluster dialog. The system notifies the users and team members that a cluster had been shared with them. To close the Share Cluster dialog, click Close.

Viewing Team’s Clusters

Any team member can check which clusters had been shared with their team. To see the shared clusters, select the team from the drop-down list to the right of the screen title.

Control Center remembers what cluster you had selected and displays it next time you open the page. If the cluster had been reassigned to another team, Control Center opens the cluster in the new team’s context.

If the Global Team feature is enabled in your Control Center environment, the Global Team option appears on the drop-down list. By default, this team includes all active Control Center users. If your environment is integrated with AD/LDAP, Global Team includes all AD/LDAP users who had logged into Control Center at least once. The environment can be configured to automatically share all clusters in Control Center with Global Team.

Stopping a Cluster Share

As a cluster owner, you can stop sharing your cluster with a team or with an individual user (remove access to the cluster that had been previously granted to that team or user).

You can stop sharing a cluster with a specific team from that team’s list of shared clusters. Select the required team from the drop-down list to the right of the screen title. Click next to the cluster you want to stop sharing with the selected team and select Stop Sharing. In the confirmation dialog, click Stop Sharing.

Alternatively, you can stop sharing a cluster with team(s) and/or user(s) from the Share Cluster dialog. Click by the cluster’s name on the list and select Share. In the Share Cluster dialog that opens, select Stop Sharing from the context menu by the required team or user name. In the confirmation dialog, click Stop Sharing.

Updating Cluster License

Your cluster may need a new license when:

  • Your previous license expires

  • You are installing (or updating to) GridGain Enterprise Edition (EE) or Ultimate Edition (UE)

Once you have obtained the license XML file, you can upload it via the Control Center UI.

To upload a new GridGain license for a cluster:

  1. From the cluster’s context menu, select Update license.

  2. In the Update license dialog that opens, do one of the following:

    • Drag and drop the license file, or

    • Click Select file and select the required file in the Explorer/Finder window.

  3. Click Update.