Updated QuickStart (markdown)

2026-11-04 00:30:15 +08:00 · 2019-06-27 22:27:08 +08:00
parent 719fcffee5
commit 8ba4d59837
1 changed files with 95 additions and 96 deletions
--- a/QuickStart.md
+++ b/QuickStart.md
@@ -1,105 +1,104 @@
-<h2>几点说明：(mysql初始化)</h2>
-<p>a.  canal的原理是基于mysql binlog技术，所以这里一定需要开启mysql的binlog写入功能，建议配置binlog模式为row. </p> 
+## 准备

-**针对阿里云RDS账号默认已经有binlog dump权限,不需要任何权限或者binlog设置,可以直接跳过这一步**
+- 对于自建 MySQL , 需要先开启 Binlog 写入功能，建议配置 binlog-format 为 ROW 模式，my.cnf 中配置如下
+  ```
+  [mysqld]
+  log-bin=mysql-bin # 开启 binlog
+  binlog-format=ROW # 选择 ROW 模式
+  server_id=1 # 配置 MySQL replaction 需要定义，不要和 canal 的 slaveId 重复
+  ```

-<pre class="java" name="code">[mysqld]
-log-bin=mysql-bin #添加这一行就ok
-binlog-format=ROW #选择row模式
-server_id=1 #配置mysql replaction需要定义，不能和canal的slaveId重复</pre>
-b.  canal的原理是模拟自己为mysql slave，所以这里一定需要做为mysql slave的相关权限.</div>
-<div class="iteye-blog-content-contain">
-<pre class="java" name="code">CREATE USER canal IDENTIFIED BY 'canal';  
-GRANT SELECT, REPLICATION SLAVE, REPLICATION CLIENT ON *.* TO 'canal'@'%';
-- GRANT ALL PRIVILEGES ON *.* TO 'canal'@'%' ;
-FLUSH PRIVILEGES;</pre>
-<p>针对已有的账户可直接通过grant
+- 注意：针对阿里云 RDS for MySQL , 默认打开了 binlog , 并且账号默认具有 binlog dump 权限 , 不需要任何权限或者 binlog 设置,可以直接跳过这一步

-## 其他场景的使用
- * 基于canal的docker模式快速启动，参考：[[Docker QuickStart]]
- * 如何将canal链接aliyun rds，参考：[[Aliyun RDS QuickStart]]
- * 如果将canal消息直接投递给kafka/RocketMQ，参考：[[Canal-Kafka-RocketMQ-QuickStart]] 
+- 授权 canal 链接 MySQL 账号具有作为 MySQL slave 的权限, 如果已有账户可直接 grant
+  ```sql
+  CREATE USER canal IDENTIFIED BY 'canal';  
+  GRANT SELECT, REPLICATION SLAVE, REPLICATION CLIENT ON *.* TO 'canal'@'%';
+  -- GRANT ALL PRIVILEGES ON *.* TO 'canal'@'%' ;
+  FLUSH PRIVILEGES;
+  ```

-<h2>启动步骤：</h2>
-<p>1.  下载canal</p>
-<p>直接下载</p>
-访问：<a href="https://github.com/alibaba/canal/releases" target="_blank">https://github.com/alibaba/canal/releases</a> ，会列出所有历史的发布版本包
-下载方式，比如以1.0.17版本为例子：
-<pre name="code" class="java">wget https://github.com/alibaba/canal/releases/download/canal-1.0.17/canal.deployer-1.0.17.tar.gz</pre>
-<p>or </p>
-<p>自己编译 </p>
-<pre name="code" class="java">git clone git@github.com:alibaba/canal.git
-cd canal; 
-mvn clean install -Dmaven.test.skip -Denv=release</pre>
-<p>    编译完成后，会在根目录下产生target/canal.deployer-$version.tar.gz </p>
-<p> </p>
-<p>2.  解压缩</p>
-<pre name="code" class="java">mkdir /tmp/canal
-tar zxvf canal.deployer-$version.tar.gz  -C /tmp/canal</pre>
-<p>   </p>
-<p>   解压完成后，进入/tmp/canal目录，可以看到如下结构：</p>
-<p> </p>
-<pre name="code" class="java">drwxr-xr-x 2 jianghang jianghang  136 2013-02-05 21:51 bin
-drwxr-xr-x 4 jianghang jianghang  160 2013-02-05 21:51 conf
-drwxr-xr-x 2 jianghang jianghang 1.3K 2013-02-05 21:51 lib
-drwxr-xr-x 2 jianghang jianghang   48 2013-02-05 21:29 logs</pre>
-<p> </p>
-<p>3.  配置修改</p>
-<p> </p>
-<p>应用参数：</p>
-<pre name="code" class="shell">vi conf/example/instance.properties</pre>
-<pre name="code" class="instance.properties">#################################################
-## mysql serverId
-canal.instance.mysql.slaveId = 1234
+## 启动

-#position info，需要改成自己的数据库信息
-canal.instance.master.address = 127.0.0.1:3306 
-canal.instance.master.journal.name = 
-canal.instance.master.position = 
-canal.instance.master.timestamp = 
+- 下载 canal, 访问 [release 页面](https://github.com/alibaba/canal/releases) , 选择需要的包下载, 如以 1.0.17 版本为例
+  ```bash
+  wget https://github.com/alibaba/canal/releases/download/canal-1.0.17/canal.deployer-1.0.17.tar.gz
+  ```

-#canal.instance.standby.address = 
-#canal.instance.standby.journal.name =
-#canal.instance.standby.position = 
-#canal.instance.standby.timestamp = 
+- 解压缩
+  ```
+  mkdir /tmp/canal
+  tar zxvf canal.deployer-$version.tar.gz  -C /tmp/canal
+  ```

-#username/password，需要改成自己的数据库信息
-canal.instance.dbUsername = canal  
-canal.instance.dbPassword = canal
-canal.instance.defaultDatabaseName =
-canal.instance.connectionCharset = UTF-8
+  - 解压完成后，进入 /tmp/canal 目录，可以看到如下结构
+    ```
+    drwxr-xr-x 2 jianghang jianghang  136 2013-02-05 21:51 bin
+    drwxr-xr-x 4 jianghang jianghang  160 2013-02-05 21:51 conf
+    drwxr-xr-x 2 jianghang jianghang 1.3K 2013-02-05 21:51 lib
+    drwxr-xr-x 2 jianghang jianghang   48 2013-02-05 21:29 logs
+    ``` 

-#table regex
-canal.instance.filter.regex = .\*\\\\..\*
+- 配置修改
+  ```
+  vi conf/example/instance.properties
+  ```
+  ```xml
+  ## mysql serverId
+  canal.instance.mysql.slaveId = 1234
+  #position info，需要改成自己的数据库信息
+  canal.instance.master.address = 127.0.0.1:3306 
+  canal.instance.master.journal.name = 
+  canal.instance.master.position = 
+  canal.instance.master.timestamp = 
+  #canal.instance.standby.address = 
+  #canal.instance.standby.journal.name =
+  #canal.instance.standby.position = 
+  #canal.instance.standby.timestamp = 
+  #username/password，需要改成自己的数据库信息
+  canal.instance.dbUsername = canal  
+  canal.instance.dbPassword = canal
+  canal.instance.defaultDatabaseName =
+  canal.instance.connectionCharset = UTF-8
+  #table regex
+  canal.instance.filter.regex = .\*\\\\..\*
+  ```
+  - canal.instance.connectionCharset 代表数据库的编码方式对应到 java 中的编码类型，比如 UTF-8，GBK , ISO-8859-1
+  - 如果系统是1个 cpu，需要将 canal.instance.parser.parallel 设置为 false

-#################################################
-</pre>
-<p> </p>
-<p> </p>
-<p> 说明：</p>
-<ul>
-<li>canal.instance.connectionCharset 代表数据库的编码方式对应到java中的编码类型，比如UTF-8，GBK , ISO-8859-1</li>
-<li>如果系统是1个cpu，需要将canal.instance.parser.parallel设置为false
-</ul>
-<p>4.   准备启动</p>
-<p> </p>
-<pre name="code" class="java">sh bin/startup.sh</pre>
-<p> </p>
-<p>5.  查看日志</p>
-<pre name="code" class="java">vi logs/canal/canal.log</pre>
-<pre name="code" class="java">2013-02-05 22:45:27.967 [main] INFO  com.alibaba.otter.canal.deployer.CanalLauncher - ## start the canal server.
-2013-02-05 22:45:28.113 [main] INFO  com.alibaba.otter.canal.deployer.CanalController - ## start the canal server[10.1.29.120:11111]
-2013-02-05 22:45:28.210 [main] INFO  com.alibaba.otter.canal.deployer.CanalLauncher - ## the canal server is running now ......</pre>
-<p>     </p>
-<p>    具体instance的日志：</p>
-<pre name="code" class="java">vi logs/example/example.log</pre>
-<pre name="code" class="java">2013-02-05 22:50:45.636 [main] INFO  c.a.o.c.i.spring.support.PropertyPlaceholderConfigurer - Loading properties file from class path resource [canal.properties]
-2013-02-05 22:50:45.641 [main] INFO  c.a.o.c.i.spring.support.PropertyPlaceholderConfigurer - Loading properties file from class path resource [example/instance.properties]
-2013-02-05 22:50:45.803 [main] INFO  c.a.otter.canal.instance.spring.CanalInstanceWithSpring - start CannalInstance for 1-example 
-2013-02-05 22:50:45.810 [main] INFO  c.a.otter.canal.instance.spring.CanalInstanceWithSpring - start successful....</pre>
-<p> </p>
-<p>6.  关闭</p>
-<pre name="code" class="java">sh bin/stop.sh</pre>
-<p> </p>
-<p>it's over. </p>
-</div>
+- 启动
+  ```
+  sh bin/startup.sh
+  ```
+
+- 查看 server 日志
+  ```
+  vi logs/canal/canal.log</pre>
+  ```
+  ```
+  2013-02-05 22:45:27.967 [main] INFO  com.alibaba.otter.canal.deployer.CanalLauncher - ## start the canal server.
+  2013-02-05 22:45:28.113 [main] INFO  com.alibaba.otter.canal.deployer.CanalController - ## start the canal server[10.1.29.120:11111]
+  2013-02-05 22:45:28.210 [main] INFO  com.alibaba.otter.canal.deployer.CanalLauncher - ## the canal server is running now ......
+  ```
+
+- 查看 instance 的日志
+  ```
+  vi logs/example/example.log
+  ```
+  ```
+  2013-02-05 22:50:45.636 [main] INFO  c.a.o.c.i.spring.support.PropertyPlaceholderConfigurer - Loading properties file from class path resource [canal.properties]
+  2013-02-05 22:50:45.641 [main] INFO  c.a.o.c.i.spring.support.PropertyPlaceholderConfigurer - Loading properties file from class path resource [example/instance.properties]
+  2013-02-05 22:50:45.803 [main] INFO  c.a.otter.canal.instance.spring.CanalInstanceWithSpring - start CannalInstance for 1-example 
+  2013-02-05 22:50:45.810 [main] INFO  c.a.otter.canal.instance.spring.CanalInstanceWithSpring - start successful....
+  ```
+
+- 关闭
+  ```
+  sh bin/stop.sh
+  ```
+
+## 其他方式
+
+- canal 的 docker 模式快速启动，参考：[[Docker QuickStart]]
+- canal 链接 aliyun rds，参考：[[Aliyun RDS QuickStart]]
+- canal 消息投递给 kafka/RocketMQ，参考：[[Canal-Kafka-RocketMQ-QuickStart]]