This Confluence has been LDAP enabled, if you are an ASF Committer, please use your LDAP Credentials to login. Any problems file an INFRA jira ticket please.

Child pages
  • Web Console
Skip to end of metadata
Go to start of metadata

Note: Please mind that Ignite Web Console in Beta

First beta was released as part of ignite-1.6 release.

Specific frameworks:

  • Frontend: AngularJS 1.5.x / Bootstrap 3.x / JADE / SASS / Webpack
  • Backend: NodeJS 6.x / fire-up

Web Agent

Ignite Web Agent is a java standalone application that allow to connect Ignite Grid to Ignite Web Console.
Ignite Web Agent communicates with grid nodes via REST interface and connects to Ignite Web Console via web-socket.

Two main functions of Ignite Web Agent:
1. Proxy between Ignite Web Console and Ignite Grid to execute SQL statements and collect metrics for monitoring.
You may need to specify URI for connect to Ignite REST server via "-n" option.

2. Proxy between Ignite Web Console and user RDBMS to collect database metadata for later CacheTypeMetadata configuration.
You may need to copy JDBC driver into "./jdbc-drivers" subfolder or specify path via "-d" option.

Usage example:
ignite-web-agent.sh

Configuration file:
Should be a file with simple line-oriented format as described here: http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html#load(java.io.Reader)

Available entries names:
tokens
server-uri
node-uri
driver-folder

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

Security tokens:
1) By default security token of current user will be included into "default.properties" inside downloaded "ignite-web-agent-x.x.x.zip".
2) One can get/reset token in Web Console profile (https://<your_console_address>/settings/profile).
3) One may specify several comma separated tokens using configuration file or command line arguments of web agent.

Ignite Web agent requirements:

  1. In order to communicate with web agent Ignite node should be started with REST server (move ignite-rest-http folder from lib/optional/ to lib/).
  2. Configure web agent serverURI property by Ignite node REST server URI.

Options:
    -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 via web-socket protocol, default value: http://localhost:3001
    -t, --tokens
        User's security tokens

How to build:
    To build from sources run following command in Ignite project root folder:

mvn clean package -pl :ignite-web-agent -am -P web-console -DskipTests=true

Web Console

Ignite Web Console is an interactive configuration wizard and management tool for Apache Ignite.

Web console 1.7

How to deploy locally:

  1. Install locally MongoDB (version >=3.x) follow instructions from site http://docs.mongodb.org/manual/installation.
  2. Install locally NodeJS (version >=4.x) using installer from site https://nodejs.org for your OS.
  3. Change directory '$IGNITE_HOME/modules/web-console/src/main/js'.

  4. Run "npm install --no-optional" in terminal in directory '$IGNITE_HOME/modules/web-console/backend for download dependencies for backend.
  5. Run "npm install --no-optional" in terminal in directory '$IGNITE_HOME/modules/web-console/frontend for download dependencies for frontend.
  6. Build ignite-web-agent module follow instructions from 'modules/web-agent/README.txt'.
  7. Copy ignite-web-agent-<version>.zip from target of ignite-web-agent module to 'modules/web-console/backend/agent_dists' folder.

Steps 1 - 7 should be executed once.

How to run console in development mode:

  1. Configure MongoDB to run as service or in terminal start MongoDB by executing "mongod".
  2. In new terminal change directory to '$IGNITE_HOME/modules/web-console/backend'.
    If needed run "npm install --no-optional" (if dependencies changed) and run "npm start" to start backend.

  3. In new terminal change directory to '$IGNITE_HOME/modules/web-console/frontend'.
    If needed run "npm install --no-optional" (if dependencies changed) and start webpack in development mode "npm run dev".

  4. In browser open: http://localhost:9000

Web console 1.6

How to deploy locally:

  1. Install locally MongoDB (version >=3.x) follow instructions from site http://docs.mongodb.org/manual/installation.
  2. Install locally NodeJS (version >=4.x) using installer from site https://nodejs.org for your OS.
  3. Change directory '$IGNITE_HOME/modules/web-console/src/main/js'.
  4. Run "npm install" in terminal for download backend dependencies.
  5. Run "jspm install" in terminal for download frontend dependencies.
  6. Build ignite-web-agent module follow instructions from 'modules/web-agent/README.txt'.
  7. Copy ignite-web-agent-<version>.zip from target of ignite-web-agent module to 'modules/web-console/src/main/js/serve/agent_dists' folder.

Steps 1 - 6 should be executed once.

How to run console in development mode:

  1. Configure MongoDB to run as service or in terminal change dir to $MONGO_INSTALL_DIR/server/3.0/bin
     and start MongoDB by executing "mongod".
  2. In new terminal change directory to '$IGNITE_HOME/modules/web-console/src/main/js'
    and start application by executing "npm start" (for first time) or "node serve" to start backend.
  3. In new terminal change directory to '$IGNITE_HOME/modules/web-console/src/main/js'
    and start virtual server and local changes watcher by executing "gulp watch --debug"
    or "gulp connect" to start web server only.
  4. In browser open: http://localhost:8090

 

  • No labels