GridGain Developers Hub
GitHub logo GridGain iso GridGain.com
GridGain Web Console Documentation

GridGain Web Console

GridGain Web Console is an interactive configuration wizard, and management and monitoring tool, built on top of Apache Ignite Web Console.

Combining the functionality of the open source version and the enterprise level features, GridGain Web Console allows you to do the following:

  • Create and download various configurations to use for your GridGain or Apache Ignite cluster.

  • Import database schemas from virtually any RDBMS.

  • Execute SQL queries over your in-memory caches and view the execution plans.

  • Monitor and manage running GridGain and Ignite clusters.

  • Monitor and manage running as well as completed queries.

wc dashboard

GridGain Web Console’s interactive configuration wizard helps you create and download configuration files and code snippets for your Apache Ignite or GridGain projects. Additionally, the tool allows you to automatically load SQL metadata from any RDBMS, run SQL queries on your in-memory cache as well as view execution plans, in-memory schema, streaming charts, and more.

Getting Started

First things first, install/deploy Web Console. You have two options: install locally via a .zip file, or use a containerized version.

Once GridGain Web Console is up and running in your environment, configure and start Ignite Web Agent by following the instructions in the section below. The agent is a gateway between the Web Console and a GridGain or Apache Ignite cluster.

Take advantage of Demo Mode if you don’t have your GridGain or Apache Ignite cluster up and running, but wish to get a feel for the Web Console.

Ignite Web Agent

Ignite Web Agent is a standalone Java application that allows you to establish a connection between a GridGain or Apache Ignite Cluster and Web Console. Ignite Web Agent communicates with the cluster nodes via a REST interface and connects to the Web Console via a web-socket.

Here are some of the functions of Ignite Web Agent:

  • Proxy between Web Console and GridGain or Ignite Grid for SQL queries execution.

    wc agent cluster
  • Proxy between Web Console and a RDBMS for database schema metadata collection. Refer to the RDBMS Integration section for more details.

    wc agent rdbms

Usage

The Ignite Web Agent zip archive ships with the ignite-web-console-agent.[sh|bat] script, used to start the agent. Make sure that the requirements below are met so that the agent can open a connection between a GridGain or Apache Ignite cluster and Web Console:

  • In order to communicate with Web Agent, a GridGain or Ignite node should be started with REST server mode enabled (copy the ignite-rest-http folder from …​/lib/optional/ to …​/lib/). If you start the node from an IDE then add the dependency below to a POM xml file:

    <dependency>
        <groupId>org.apache.ignite</groupId>
        <artifactId>ignite-rest-http</artifactId>
        <version>{ignite.version}</version>
    </dependency>
  • Configure the Web Agent’s serverURI property in a way that it refers to the Ignite node’s REST server URI. By default, the agent connects to /http://localhost:8080.

Starting the Web Agent

In the terminal, start the web agent from the ignite web agent directory using the ignite-web-console-agent.[sh|bat] script:

$ ./ignite-web-console-agent.sh
$ ignite-web-console-agent.bat

Configuration

Configuration file

By default, Ignite Web Agent makes an attempt to load configuration settings from the default.properties file. The content of the file has to follow a simple line-oriented format as described here.

Available entries' names are: tokens, server-uri, node-uri, driver-folder

tokens=1a2b3c4d5f,2j1s134d12
serverURI=https://console.example.com:3001

Command line options

To get help, execute ignite-web-console-agent.[sh|bat] -h or ignite-web-console-agent.[sh|bat] --help in a terminal.

Available options with their descriptions:

  • -h, --help - Print this help message

  • -c, --config - Path to configuration file

  • -d, --driver-folder - Path to folder with JDBC drivers, default value: ./jdbc-drivers

  • -n, --node-uri - URI for connect to Ignite REST server, default value: http://localhost:8080

  • -s, --server-uri - URI for connect to Ignite Web Console, default value: http://localhost:3001

  • -t, --tokens - User’s tokens separated by comma used to connect to Ignite Console

  • nks, --node-key-store - Path to key store that will be used to connect to cluster

  • -nksp, --node-key-store-password - Optional password for node key store

  • -nts, --node-trust-store - Path to trust store that will be used to connect to cluster

  • -ntsp, --node-trust-store-password - Optional password for node trust store

  • -sks, --server-key-store - Path to key store that will be used to connect to Web server

  • -sksp, --server-key-store-password - Optional password for server key store

  • -sts, --server-trust-store - Path to trust store that will be used to connect to Web server

  • -stsp, --server-trust-store-password - Optional password for server trust store

  • -pks, --passwords-key-store - Path to key store that keeps encrypted passwords

  • -pksp, --passwords-key-store-password - Password for passwords key store

  • -cs, --cipher-suites - Optional comma-separated list of SSL cipher suites to be used to connect to server and cluster

Proxy Configuration

Proxy can be configured by passing system properties, in the JVM_OPTS environment variable, to the web agent.

Detailed description for each property can be found in the following documentation: http://docs.oracle.com/javase/7/docs/api/java/net/doc-files/net-properties.html

HTTP

http.proxyHost - Hostname or address of the proxy server

http.proxyPort - Port number of the proxy server

For using proxy with authentication, you need to provide following system properties:

http.proxyUsername - Username

http.proxyPassword - Password

JVM_OPTS="-Dhttp.proxyHost=<proxy-hostname> -Dhttp.proxyPort=<proxy-port> -Dhttp.proxyUsername=<proxy-username> -Dhttp.proxyPassword=<proxy-password>" ./ignite-web-console-agent.sh
set JVM_OPTS=-Dhttp.proxyHost=<proxy-hostname> -Dhttp.proxyPort=<proxy-port> -Dhttp.proxyUsername=<proxy-username> -Dhttp.proxyPassword=<proxy-password>
./ignite-web-console-agent.bat

HTTPS

https.proxyHost - Hostname or address of the proxy server

https.proxyPort - Port number of the proxy server

For using proxy with authentication, you need to provide the following system properties:

https.proxyUsername - Username

https.proxyPassword - Password

JVM_OPTS="-Dhttps.proxyHost=<proxy-hostname> -Dhttps.proxyPort=<proxy-port> -Dhttps.proxyUsername=<proxy-username> -Dhttps.proxyPassword=<proxy-password>" ./ignite-web-console-agent.sh
set JVM_OPTS=-Dhttps.proxyHost=<proxy-hostname> -Dhttps.proxyPort=<proxy-port> -Dhttps.proxyUsername=<proxy-username> -Dhttps.proxyPassword=<proxy-password>
./ignite-web-console-agent.bat

SOCKS

socksProxyHost - Hostname or address of the proxy server

socksProxyPort - Port number of the proxy server

For using proxy with authentication, you need to provide the following system properties:

java.net.socks.username - Username

java.net.socks.password - Password

JVM_OPTS="-DsocksProxyHost=<proxy-hostname> -DsocksProxyPort=<proxy-port> -Djava.net.socks.username=<proxy-username> -Djava.net.socks.password=<proxy-password>" ./ignite-web-console-agent.sh
set JVM_OPTS= -DsocksProxyHost=<proxy-hostname> -DsocksProxyPort=<proxy-port> -Djava.net.socks.username=<proxy-username> -Djava.net.socks.password=<proxy-password>
./ignite-web-console-agent.bat

Additional Information

Refer to the relevant Apache Ignite documentation to start with the tool:

Learn how to deploy GridGain using a Docker image or directly on the underlying host operating system:

Visit the pages below to have a quick look at open source console’s capabilities:

Here you can learn more about enterprise level features supported by GridGain only: