Getting Started

❗️

This is a legacy Apache Ignite documentation

The new documentation is hosted here: https://ignite.apache.org/docs/latest/

Installation

Ignite Web Console is a web application that needs to be built, packaged and deployed in your environment. In addition, it requires you to install NodeJS, MongoDB and Ignite Web Agent. Please go to Build and Deploy documentation and follow the instructions provided there.

👍

Free Deployed Ignite Web Console Instance

Before building and deploying your local instance of Ignite Web Console, you can give a shot to the already deployed Ignite Web Console instance available for free. By taking advantage of this hosted deployment, you can check all existing capabilities in action in a matter of minutes.

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

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

Ignite Web Agent

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

As an example, these are some of the functions of Ignite Web Agent:

• Proxy between Ignite Web Console and Ignite Grid for SQL queries execution purposes.
• Proxy between Ignite Web Console and a RDBMS for database schema metadata collection. Refer to RDBMS Integration section for more details.

Usage

Ignite Web Agent zip ships with ignite-web-agent.{sh|bat} script that is used to start the agent. Make sure that the requirements below are met so that the agent can open up a connection between an Apache Ignite cluster and Ignite Web Console:

• In order to communicate with Web Agent, an Ignite node should be started with REST server mode enabled (move 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-agent.{sh|bat} script, like so:

$ ./ignite-web-agent.sh

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-agent.{sh|bat} -h or ignite-web-agent.{sh|bat} --help in 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 security tokens

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-agent.sh

set JVM_OPTS=-Dhttp.proxyHost=<proxy-hostname> -Dhttp.proxyPort=<proxy-port> -Dhttp.proxyUsername=<proxy-username> -Dhttp.proxyPassword=<proxy-password>
./ignite-web-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-agent.sh

set JVM_OPTS=-Dhttps.proxyHost=<proxy-hostname> -Dhttps.proxyPort=<proxy-port> -Dhttps.proxyUsername=<proxy-username> -Dhttps.proxyPassword=<proxy-password>
./ignite-web-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-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-agent.bat