Web Agent Configuration

Configuration File

By default, 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.

The following properties can be set:

Property Description

Property	Description
`tokens`	A list of security tokens of the users registered in Web Console. The users whose tokens are provided in the configuration file will be able to manage the cluster this agent is connected to.
`server-uri`	The URI of the Web Console server. The default value is `http://localhost:8008`.
`node-uri`	A comma separated list of the URIs of the nodes the Web Agent will connect to. The URI consists of the node’s IP address and the configured REST port. The default value is `http://localhost:8080`.
`driver-folder`	The path to a directory with the JDBC drivers for the database you are going to import schema configuration from.

tokens

A list of security tokens of the users registered in Web Console. The users whose tokens are provided in the configuration file will be able to manage the cluster this agent is connected to.

server-uri

The URI of the Web Console server. The default value is http://localhost:8008.

node-uri

A comma separated list of the URIs of the nodes the Web Agent will connect to. The URI consists of the node’s IP address and the configured REST port. The default value is http://localhost:8080.

driver-folder

The path to a directory with the JDBC drivers for the database you are going to import schema configuration from.

tokens=1a2b3c4d5f,2j1s134d12
server-uri=https://console.example.com:8008

Command Line Options

To get help, execute web-console-agent.[sh|bat] -h or 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 - A comma separated list of the URIs of the nodes the Web Agent will connect to. The URI consists of the node’s IP address and the configured REST port. The default value is http://localhost:8080.
-s, --server-uri - URI for connect to Ignite Web Console, default value: http://localhost:8008
-t, --tokens - User’s tokens separated by comma used to connect to Web 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>" ./web-console-agent.sh

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

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

© 2024 GridGain Systems, Inc. All Rights Reserved. Privacy Policy | Legal Notices. GridGain® is a registered trademark of GridGain Systems, Inc.
Apache, Apache Ignite, the Apache feather and the Apache Ignite logo are either registered trademarks or trademarks of The Apache Software Foundation.

Last updated on Jan 26, 2024