@liyuj
2018-01-29T11:02:09.000000Z
字数 10417
阅读 5719
Apache-Ignite-2.3.0-中文开发手册
Ignite Web控制台
是一个交互式的配置向导、管理和监控工具。它可以:
Ignite的Web控制台,是一个可以部署在系统环境中的Web应用。它可以配置所有的集群属性,从数据库中导入模式用于与持久化存储集成。它可以接入特定的数据库然后生成所有必要的OR映射配置(XML以及纯Java)以及Java领域模型POJOs。Web控制台还有集群监控的功能(使用GridGain单独的插件实现),它会显示各种缓存以及节点的指标数据,比如CPU和堆的使用情况等。
Ignite的Web控制台是一个WEB应用,需要构建、打包然后部署在自己的环境上。另外,它需要安装NodeJS,MongoDB以及Ignite的Web代理。
参照构建和部署
章节的文档,然后按照步骤操作即可。
一个免费已部署的Ignite Web控制台实例
在构建和部署自己的本地Ignite Web控制台实例之前,可以看一下一个免费已部署的Web控制台实例,利用这个站点,花几分钟就可以大概了解控制台的已有功能。
Ignite的Web控制台启动运行之后,需要按照下面章节的步骤配置并且启动Web代理,代理是Ignite的Web控制台和Ignite集群之间的媒介。
Ignite的Web代理是一个独立的Java应用,它可以建立Ignite集群与Web控制台之间的连接。Web Agent与集群节点间采用REST接口进行通信,而与Web控制台之间采用WebSocket进行通信。
举例来说,Ignite的Web Agent功能如下:
使用
Ignite Web代理的zip压缩包中的ignite-web-agent.{sh|bat}
脚本可用于启动这个代理。一定要满足下面的必要条件,使得代理可以在Ignite集群和Ignite Web控制台之间建立连接。
1.为了与Web代理通信,Ignite节点需要开启REST服务模式(将ignite-rest-http
文件夹从lib/optional/
移动到lib/
中)。如果是从IDE启动节点,那么需要将下面的依赖加入pom.xml文件;
<dependency>
<groupId>org.apache.ignite</groupId>
<artifactId>ignite-rest-http</artifactId>
<version>{ignite.version}</version>
</dependency>
2.配置Web代理的serverURI
属性,将其指向Ignite节点的REST服务的URL,代理默认会连接http://localhost:8080
。
配置
配置文件
Ignite的Web代理默认会试图从default.properties
文件中加载配置。这个文件的内容需要遵循一个简单的基于行的格式。
可用的属性名包括:tokens
,server-uri
,node-uri
,driver-folder
。
tokens=1a2b3c4d5f,2j1s134d12
serverURI=https://console.example.com:3001
命令行参数
要获得帮助,可以在终端中执行ignite-web-agent.{sh|bat} -h
或者ignite-web-agent.{sh|bat} --help
。
可用的属性如下:
-h
,--help
:输出帮助信息;-c
,--config
:配置文件路径;-d
,--driver-folder
:JDBC驱动所在文件夹路径,默认值是./jdbc-drivers
;-n
,--node-uri
:要接入的Ignite REST服务端的URI,默认值是http://localhost:8080
;-s
,--server-uri
:要接入的Ignite Web控制台的URI,默认值是http://localhost:3001
;-t
,--tokens
:用户的安全令牌。代理配置
代理可以通过将系统属性、JVM_OPTS
环境变量的方式传给Web代理。
在如下文档中可以找到详细的描述:
http://docs.oracle.com/javase/7/docs/api/java/net/doc-files/net-properties.html。
HTTP
http.proxyHost
:代理服务器的主机名或者地址;
http.proxyPort
:代理服务器的端口号。
如果代理需要认证的话,还需要提供如下的系统属性:
http.proxyUsername
:用户名;
http.proxyPassword
:密码。
Shell:
JVM_OPTS="-Dhttp.proxyHost=<proxy-hostname> -Dhttp.proxyPort=<proxy-port> -Dhttp.proxyUsername=<proxy-username> -Dhttp.proxyPassword=<proxy-password>" ./ignite-web-agent.sh
CMD:
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
:代理服务器的主机名或者地址;
https.proxyPort
:代理服务器的端口号。
如果代理需要认证的话,还需要提供如下的系统属性:
https.proxyUsername
:用户名;
https.proxyPassword
:密码。
Shell:
JVM_OPTS="-Dhttps.proxyHost=<proxy-hostname> -Dhttps.proxyPort=<proxy-port> -Dhttps.proxyUsername=<proxy-username> -Dhttps.proxyPassword=<proxy-password>" ./ignite-web-agent.sh
CMD:
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
:代理服务器的主机名或者地址;
socksProxyPort
:代理服务器的端口号。
如果代理需要认证的话,还需要提供如下的系统属性:
java.net.socks.username
:用户名;
java.net.socks.password
:密码。
Shell:
JVM_OPTS="-DsocksProxyHost=<proxy-hostname> -DsocksProxyPort=<proxy-port> -Djava.net.socks.username=<proxy-username> -Djava.net.socks.password=<proxy-password>" ./ignite-web-agent.sh
CMD:
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
为了在本地部署Ignite的Web控制台,需要先安装:
开始之前需要下载依赖:
cd $IGNITE_HOME/modules/web-console/backend
npm install --no-optional
cd $IGNITE_HOME/modules/web-console/frontend
npm install --no-optional
要从源代码构建Ignite的Web代理,需要在$IGNITE_HOME
文件夹中执行如下的命令:
mvn clean package -pl :ignite-web-agent -am -P web-console -DskipTests=true
构建过程完成后,会在$IGNITE_HOME/modules/web-console/web-agent/taget
中找到ignite-web-agent-x.x.x.zip
。
要在开发模式中运行Ignite的Web控制台,可以按照如下步骤操作:
mongod
命令来启动MongoDB;ignite-web-agent-x.x.x.zip
复制到$IGNITE_HOME/modules/web-console/backend/agent_dists
文件夹;$IGNITE_HOME/modules/web-console/backend
,如果需要,运行npm install --no-optional
(如果依赖改变),然后运行npm start
启动后台;$IGNITE_HOME/modules/web-console/frontend
,如果需要,运行npm install --no-optional
(如果依赖改变),然后运行npm run dev
以开发模式启动webpack;http://localhost:9000
;2.2.入门
章节中可以看到如何将部署的控制台接入一个远程集群,或者如何在远程主机上访问控制台。前提条件
启动后台
mongod
命令来启动MongoDB;ignite-web-agent-x.x.x.zip
复制到$IGNITE_HOME/modules/web-console/backend/agent_dists
文件夹;$IGNITE_HOME/modules/web-console/backend
;npm start
启动后台。如果希望以守护进程模式运行后台,需要为NodeJS应用使用进程管理器:pm2,forever等。
构建前台
$IGNITE_HOME/modules/web-console/frontend
;npm run build
为Web服务器生成文件(html、js、css);$IGNITE_HOME/modules/web-console/frontend/build
。配置Apache HTTP Server
$IGNITE_HOME/modules/web-console/frontend/build
文件夹的内容复制到$IGNITE_HOME/modules/web-console/frontend/build
;/etc/httpd/conf/httpd.conf
:
<VirtualHost *:80>
ServerName www.WEB_CONSOLE_HOSTNAME
ServerAlias WEB_CONSOLE_HOSTNAME
DocumentRoot "/var/www/web-console-static"
RewriteEngine on
<Directory "/var/www/web-console-static">
AllowOverride All
Allow from all
</Directory>
ProxyRequests off
<proxy *>
Order deny,allow
Allow from all
</proxy>
ProxyPreserveHost On
RequestHeader set Host "WEB_CONSOLE_HOSTNAME"
RewriteCond %{DOCUMENT_ROOT}%{REQUEST_URI} -f
RewriteRule ^ - [L]
RewriteCond %{HTTP:UPGRADE} ^WebSocket$ [NC]
RewriteCond %{HTTP:CONNECTION} ^Upgrade$ [NC]
RewriteRule .* ws://localhost:3000%{REQUEST_URI} [P,L]
RewriteCond %{REQUEST_URI} ^/agents/.* [OR]
RewriteCond %{REQUEST_URI} ^/socket.io/.*
RewriteRule ^ http://localhost:3000%{REQUEST_URI} [P,L]
RewriteCond %{REQUEST_URI} ^/api/v1/.*$
RewriteRule ^/api/v1/(.*)$ http://localhost:3000/$1 [P,L]
RewriteRule ^ /index.html [L]
</VirtualHost>
上面文件中的WEB_CONSOLE_HOSTNAME,需要替换为部署Web控制台实例的机器的主机名。
如果Apache HTTP Server还用于部署的Web控制台,那么下面的配置也需要添加到/etc/httpd/conf/httpd.conf
:
httpd.conf:
ServerName localhost
DocumentRoot "/var/www/web-console-static"
RewriteEngine on
<Directory "/var/www/web-console-static">
AllowOverride All
Allow from all
</Directory>
ProxyRequests off
<proxy *>
Order deny,allow
Allow from all
</proxy>
ProxyPreserveHost On
RequestHeader set Host "EXTERNAL_SERVER_IP"
RewriteCond %{DOCUMENT_ROOT}%{REQUEST_URI} -f
RewriteRule ^ - [L]
RewriteCond %{REQUEST_URI} ^/agents/.* [OR]
RewriteCond %{REQUEST_URI} ^/socket.io/.*
RewriteRule ^ http://localhost:3000%{REQUEST_URI} [P,L]
RewriteCond %{HTTP:UPGRADE} ^WebSocket$ [NC]
RewriteCond %{HTTP:CONNECTION} ^Upgrade$ [NC]
RewriteRule .* ws://localhost:3000%{REQUEST_URI} [P,L]
RewriteCond %{REQUEST_URI} ^/api/v1/.*$
RewriteRule ^/api/v1/(.*)$ http://localhost:3000/$1 [P,L]
RewriteRule ^ /index.html [L]
上面的EXTERNAL_SERVER_IP,需要替换为部署Web控制台实例的机器的主机名。
执行sudo apachectl restart
重启Apache HTTP Server以使配置生效。
打开浏览器,根据部署类型打开下面的地址中的一个:http://WEB_CONSOLE_HOSTNAME
或http://EXTERNAL_SERVER_IP
。
配置nginx HTTP Server
$IGNITE_HOME/modules/web-console/frontend/build
文件夹中的内容复制到/var/www/web-console-static
;/etc/nginx/conf.d/web-console.conf
,内容如下:
upstream backend-api {
server localhost:3000;
}
server {
listen 80;
server_name EXTERNAL_SERVER_IP WEB_CONSOLE_HOSTNAME;
set $ignite_console_dir /var/www/web-console-static;
root $ignite_console_dir;
error_page 500 502 503 504 /50x.html;
location / {
try_files $uri /index.html = 404;
}
location /api/v1 {
rewrite /api/v1/(.*) /$1 break;
proxy_set_header Host $http_host;
proxy_pass http://backend-api;
}
location /socket.io {
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_http_version 1.1;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header Host $host;
proxy_pass http://backend-api;
}
location /agents {
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_http_version 1.1;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header Host $host;
proxy_pass http://backend-api;
}
location = /50x.html {
root $ignite_console_dir/error_page;
}
}
上面的EXTERNAL_SERVER_IP,需要替换为部署Web控制台实例的机器的主机名。
WEB_CONSOLE_HOSTNAME,需要替换为部署Web控制台实例的机器的主机名。
执行sudo service nginx restart
重启Nginx HTTP Server以使配置生效。
打开浏览器,根据部署类型打开下面的地址中的一个:http://WEB_CONSOLE_HOSTNAME
或http://EXTERNAL_SERVER_IP
。
问题解决
如果在浏览器中出现了Forbidden
这样的错误,那么需要检查操作系统中所有的安全策略都配置正确了。
可以使用Web控制台的演示模式来研究和评估它有关配置和管理集群的各种功能,这个模式中,可以检查预定义的集群、缓存以及领域模型,它还启动了一个内置的H2数据库实例,可以执行各种SQL查询以及查看数据报表,还可以监控各种缓存和节点的指标,比如集群的CPU和堆使用量等。
要开启演示模式,需要点击控制台顶部菜单的Start demo
按钮。
ignite-web-agent
目录,运行如下的命令:
./ignite-web-agent.sh
启动Web代理之后,回到浏览器中就可以:
配置集群和缓存
点击控制台侧边栏上的Clusters
和Caches
,可以查看和设定Ignite的配置参数,点击Summary
可以下载这些配置的XML和Java格式文件,这个页面还可以下载一个可用的基于Maven的工程。
导入领域模型
演示模式中,已连接的Web代理中已经启动了H2数据库实例,如下方法可以验证:
Domain model
界面;Import from database
,可以看到一个描述Demo的模态窗口;Next
会看到一个可用模式的列表;Next
会看到一个可用表的列表;Next
会看到导入的选项;选择之后点击Save
。
执行SQL查询
该模式中,会启动一个客户端和三个服务端节点,会创建一些缓存并且注入了数据,如下方法可以验证:
点击Web控制台顶层菜单的Queries
选项卡;
SQL Demo
查询的笔记本;Country, Department, Employee, Parking, Car
;比如输入如下的SQL:
SELECT p.name, count(*) AS cnt FROM "ParkingCache".Parking p`
`INNER JOIN "CarCache".Car c ON (p.id) = (c.parkingId)`
`GROUP BY P.NAME
Execute
按钮,会获得表中的若干数据;charts
按钮,可以看到自动生成的图表。在本地环境中部署Ignite Web控制台的最简单方式是使用控制台的Docker映像,如果基于Docker的方式不可行,那么可以参照2.3.构建和部署
章节的内容。
下面是部署的完整步骤:
docker pull apacheignite/web-console-standalone
;docker run -d -p 80:80 -v <host_absolute_path>:/var/lib/mongodb --name web-console-standalone apacheignite/web-console-standalone
。注意
1.需要使用sudo
来运行docker命令;
2.如果80
端口已被占用,那么容器端口需要映射到其他的可用端口。比如,下面的命令将容器的80
端口绑定的宿主机的8080
端口:sudo docker run -d -p 8080:80 -v <host_absolute_path>:/var/lib/mongodb --name web-console-standalone apacheignite/web-console-standalone
;
3.<host_absolute_path>
:是宿主机中MongoDB创建数据库文件的路径。这个文件夹应该在docker运行前创建好,打开Docker->Preferences->File Sharing
然后在那里创建目录,或者使用其他的方式也行;
http://localhost
或者http://host-ip-of-computer-with-docker-image
,如果默认端口有变,那么地址为:http://localhost:<host_port>
。Docker更新容器的方式如下:
docker pull apacheignite/web-console-standalone
docker stop apacheignite/web-console-standalone
docker rm apacheignite/web-console-standalone
docker run -d -p 80:80 -v <host_absolute_path>:/var/lib/mongodb --name web-console-standalone apacheignite/web-console-standalone