Updated Canal Admin QuickStart (markdown)

agapple
2019-08-31 15:45:40 +08:00
parent da18f4fbfb
commit 588234e9a5

@@ -1,8 +1,38 @@
## 背景
canal-admin设计上是为canal提供整体配置管理、节点运维等面向运维的功能,提供相对友好的WebUI操作界面,方便更多用户快速和安全的操作
## 准备
canal-admin的限定依赖:
1. MySQL,用于存储配置和节点等相关数据
2. canal版本,要求>=1.1.4 (需要依赖canal-server提供面向admin的动态运维管理接口)
## 部署
1. 导入mysql脚本:canal-admin/canal_manager.sql
1. 下载 canal-admin, 访问 release 页面 , 选择需要的包下载, 如以 1.1.4 版本为例
```
wget https://github.com/alibaba/canal/releases/download/canal-1.1.4/canal.admin-1.1.4.tar.gz
```
2. 解压缩
```
mkdir /tmp/canal-admin
tar zxvf canal.admin-$version.tar.gz -C /tmp/canal-admin
```
解压完成后,进入 /tmp/canal 目录,可以看到如下结构
```
drwxr-xr-x 6 agapple staff 204B 8 31 15:37 bin
drwxr-xr-x 8 agapple staff 272B 8 31 15:37 conf
drwxr-xr-x 90 agapple staff 3.0K 8 31 15:37 lib
drwxr-xr-x 2 agapple staff 68B 8 31 15:26 logs
```
3. 配置修改
```
vi conf/application.yml
```
2. 在 canal-admin.jar的同级目录下创建application.yml配置:
```
server:
port: 8089
@@ -12,30 +42,51 @@ spring:
time-zone: GMT+8
spring.datasource:
url: jdbc:mysql://127.0.0.1:3306/canal_manager?useUnicode=true&characterEncoding=UTF-8&useSSL=false
username: root
password: 121212
driver-class-name: com.mysql.jdbc.Driver
hikari:
maximum-pool-size: 10
minimum-idle: 1
```
并修改对应的数据源
# 修改MySQL元数据库的地址、账号、密码等
url: jdbc:mysql://127.0.0.1:3306/canal_manager?useUnicode=true&characterEncoding=UTF-8&useSSL=false
username: root
password: 121212
driver-class-name: com.mysql.jdbc.Driver
hikari:
maximum-pool-size: 10
minimum-idle: 1
3. 启动canal-admin:
canal:
adminUser: admin
adminPasswd: admin
```
java -jar canal-admin.jar
```
访问地址:http://ip:8089/index.html
即可访问
4. 修改canal-server的配置, canal.properties:
4. 初始化元数据库
```
#################################################
######### common argument #############
#################################################
#canal.manager.jdbc.url=jdbc:mysql://127.0.0.1:3306/canal_manager?useUnicode=true&characterEncoding=UTF-8&useSSL=false
#canal.manager.jdbc.username=root
#canal.manager.jdbc.password=121212
mysql -h127.1 -uroot -p
# 导入初始化SQL
> source conf/canal_manager.sql
```
只保留数据源配置即可
a. 初始化SQL脚本里会默认创建canal_manager的数据库,建议使用root等有超级权限的账号进行初始化
b. canal_manager.sql默认会在conf目录下,也可以通过链接下载 [canal_manager.sql](https://raw.githubusercontent.com/alibaba/canal/master/canal-admin/canal-admin-server/src/main/resources/canal_manager.sql)
5. 启动
```
sh bin/startup.sh
```
查看 admin 日志
```
vi logs/admin.log
2019-08-31 15:43:38.162 [main] INFO o.s.boot.web.embedded.tomcat.TomcatWebServer - Tomcat initialized with port(s): 8089 (http)
2019-08-31 15:43:38.180 [main] INFO org.apache.coyote.http11.Http11NioProtocol - Initializing ProtocolHandler ["http-nio-8089"]
2019-08-31 15:43:38.191 [main] INFO org.apache.catalina.core.StandardService - Starting service [Tomcat]
2019-08-31 15:43:38.194 [main] INFO org.apache.catalina.core.StandardEngine - Starting Servlet Engine: Apache Tomcat/8.5.29
....
2019-08-31 15:43:39.789 [main] INFO o.s.w.s.m.m.annotation.ExceptionHandlerExceptionResolver - Detected @ExceptionHandler methods in customExceptionHandler
2019-08-31 15:43:39.825 [main] INFO o.s.b.a.web.servlet.WelcomePageHandlerMapping - Adding welcome page: class path resource [public/index.html]
```
此时代表canal-admin已经启动成功,可以通过 http://127.0.0.1:8089/ 访问,just have fun!
6. 关闭
```
sh bin/stop.sh
```