GridGain Developers Hub

My Cluster Tab

My cluster opens as the first tab of the Dashboard screen when you select Dashboard from the navigation menu. It displays numeric and tabular information for the "current" cluster (selected in the cluster selector tool on the main toolbar).

my cluster 1

Viewing Cluster Information

Use the widgets to view the relevant cluster information:

Widget Description

Cluster Health

The cluster status:

  • Warnings - at least one of the alerts for the cluster has been triggered

  • Errors - partition loss

  • Healthy - neither warnings nor errors are observed

Connections

A set of chips for adding connections.

Details

A table of the cluster details, including Type, ID, Owner, etc.

Nodes

A list of cluster’s nodes.

Viewing Cluster Health Details

To view details of the cluster health (status), in the Cluster Health widget, click the View Details link. The Cluster Health Details dialog shows what specific problems, if any, are observed in the cluster.

Cluster health details GridGain 9

Viewing Cluster Nodes

The cluster nodes are shown in the Nodes widget at the bottom of the screen.

To auto-size a specific column or all columns in the table, select the corresponding option from the column’s context menu.

To add columns to the table or remove them from the table, select the Table Columns option from the table’s context menu, then select or clear check boxes for the columns on the list that opens.

To define the auto-adjustment timeout, click the Configuration icon above the node list, toggle the auto-adjustment on, then enter the timeout value (in seconds).

For GridGain 9 clusters, the Nodes widget displays the following columns:

Column Description

Name

The node name.

Node ID

The ID of the node.

Host

The cluster host IP address.

Port

The cluster host port.

CMG

Whether the node is included in Cluster Management Group.

MS

Whether the node is included in the Metastorage Group.

HTTP, HTTPS ports

The ports the node exposes.

Status

Running or Validating - see explanation.

Adding Connections

To add a connection to the cluster, in the Connections widget:

  1. Click the required client/protocol chip.

  2. Proceed to define the new connection.

Initializing the Cluster

To initialize the attached GridGain 9 cluster:

  1. Click Initialize in the top right corner.

    The Initialize cluster dialog opens.

    Initialize cluster
  2. Add configuration and license file(s) using the Browse button or by dragging and dropping.

  3. Optionally:

    1. Expand the Advanced settings section.

      Advanced settings
    2. Clear the Cluster Management Group (CMG) nodes same as MS nodes check box.

      Advanced settings with checkbox clear
    3. Manually assign MS and CMG nodes.

    4. To reset the MS and CMG nodes to default configurations, click Reset to default.

  4. Click Initialize.

The dialog closes. Once the initialization process is completed, the cluster status in the My Cluster screen changes to Active.

Cluster Configuration

To change cluster configuration click the ⋮ in the right corner of My Cluster tab and then choose Configuration option from the menu. To enable the metric exporter for attached clusters, select option 'Metrics'. To enable Running Queries monitoring, select 'Running queries' option in the same dialog.

cluster config update "ignite.metrics.exporters=[
    {
        compression=none
        endpoint="{connector_address}"
        exporterName=otlp
        headers=[]
        name="cc_exporter"
        period=5000
        protocol="http/protobuf"
    }
]"
  • If you are using a custom connector for metrics, then in the endpoint field, enter the connector address that is reachable from the cluster nodes. Its value should match cc.base-url as documented in the Cloud Connector section.

  • If you prefer to use the embedded connector, then set the endpoint to the Nebula portal address: https://portal.gridgain.com/.

Initializing the Cluster

To initialize the attached GridGain 9 cluster:

  1. Click Initialize in the top right corner.

    The Initialize cluster dialog opens.

    Initialize cluster
  2. Add configuration and license file(s) using the Browse button or by dragging and dropping.

  3. Optionally:

    1. Expand the Advanced settings section.

      Advanced settings
    2. Clear the Cluster Management Group (CMG) nodes same as MS nodes check box.

      Advanced settings with checkbox clear
    3. Manually assign MS and CMG nodes.

    4. To reset the MS and CMG nodes to default configurations, click Reset to default.

  4. Click Initialize.

The dialog closes. Once the initialization process is completed, the cluster status in the My Cluster screen changes to Active.

Cluster Configuration

To change cluster configuration click the ⋮ in the right corner of My Cluster tab and then choose Configuration option from the menu. To enable the metric exporter for attached clusters, select option 'Metrics'. To enable Running Queries monitoring, select 'Running queries' option in the same dialog.

cluster config update "ignite.metrics.exporters=[
    {
        compression=none
        endpoint="{connector_address}"
        exporterName=otlp
        headers=[]
        name="cc_exporter"
        period=5000
        protocol="http/protobuf"
    }
]"
  • If you are using a custom connector for metrics, then in the endpoint field, enter the connector address that is reachable from the cluster nodes. Its value should match cc.base-url as documented in the Cloud Connector section.

  • If you prefer to use the embedded connector, then set the endpoint to the Nebula portal address: https://portal.gridgain.com/.

Managing Cluster API Credentials

To access a cluster, applications need to authenticate to it using API "user" credentials. When creating a cluster, you specify one set of API credentials. Once the cluster had been provisioned, you can add API credential sets, modify them, and delete the ones that are no longer required.

To manage API credentials:

  1. From the context menu, select API credentials.

    The Manage API credentials dialog opens. It list all API "users" defined for the cluster.

    manage creds
  2. To add a "user":

    1. Click Add API credentials.

      The Add API credentials dialog opens.

      add creds
    2. Enter the Username and Password values.

    3. Click Add.

  3. To change a "user" password:

    1. From the user’s context menu, select Change password.

      The Change password for <username> dialog opens.

      edit creds
    2. Enter the new Password.

    3. Click Change.

  4. To remove a "user", select Remove from that user’s context menu.

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.

Sharing with Users and Teams

To share the current cluster, click Share above the Details widget. The Share cluster dialog opens.

share cluster 1

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 GridGain Nebula 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.

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).

To stop sharing a cluster with team(s) and/or user(s), click Share above the Details widget.

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.

Viewing Graphic Dashboards

To view the default graphic dashboard for the current cluster, click the Default next to the My cluster tab in the top left corner of the screen.

Switching Between Clusters

If multiple clusters are registered in GridGain Nebula, you can switch between clusters by using the Select cluster control on the top toolbar.

Adding Clusters

To add a cluster, click + on the top toolbar. From the menu that opens, select an option:

Next Steps