Skip to main content

快速上手

本文档以Linux/MacOS系统为例，演示如何使用CloudCanal社区版默认自带的机器和数据源来从 0 到 1 部署并快速构建出一条带结构迁移、数据初始化以及数据同步的任务。

前置条件

机器准备

  • 准备 1 台 Linux/MacOS 系统的机器,推荐 2C8G、4C8G 或更好的机器

环境准备

  • CloudCanal 是一个分布式系统，故会占用 8111、9090、55000、25000、55005、7007 端口，部署前请确保这些端口未被其他应用占用
  • 控制台请使用 chrome 浏览器访问，其他浏览器可能出现体验不畅等问题

docker 准备

  • 确保机器已经安装了版本 17 以上的docker，如未安装，参考文档 https://docs.docker.com/engine/install/ 进行安装
  • 确保机器已经安装了 docker-compose 环境，如未安装，参考以下文档进行安装
    • 官方文档指导安装: https://docs.docker.com/compose/install/#alternative-install-options
    • 国内镜像站安装
      curl -L https://get.daocloud.io/docker/compose/releases/download/1.28.5/docker-compose-`uname -s`-`uname -m` > 
      /usr/local/bin/docker-compose
      chmod +x /usr/local/bin/docker-compose
      ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
  • 如您的操作系统为 MacOS，请提前为 docker 分配内存

安装部署

下载安装包

解压安装包

  • 安装包为 cloudcanal.7z，包含了镜像和管理脚本

  • 安装 7z 解压工具(请确保该机器没有安装过CloudCanal，如安装过，请卸载后再安装，或者进行版本升级操作)

    # 安装7z命令(centos系)
    sudo yum install p7zip p7zip-plugins
    # 安装7z命令(ubuntu系)
    sudo apt-get install p7zip-full p7zip-rar
    # 安装7z命令（macOS)
    brew install 7z

  • 进入安装包所在目录，解压缩

    • 7z x cloudcanal.7z

  • 解压目录如下，其中包括

    • 镜像:包含四个 tar 压缩文件

    • 脚本:启动、更新和停止，以及 scripts 运维脚本目录

    • 日志与配置文件:日志为 docker-compose 启动日志，配置文件为 docker-compose 配置文件

       [root@localhost tar]# ll
       -rw-------. 1 root root  862506496 Mar 25 11:47 console.tar
       -rw-r--r--. 1 root root       1392 Mar 25 12:07 docker-compose.yml
       -rw-------. 1 root root  454221312 Mar 25 11:47 mysql.tar
       -rw-------. 1 root root  174073344 Mar 25 11:49 prometheus.tar
       -drwxr-xr-x. 2 root root        124 Mar 25 12:05 scripts
       -rwxr-xr-x. 1 root root         63 Mar 25 12:05 shutdown.sh
       -rw-------. 1 root root 1231059968 Mar 25 11:48 sidecar.tar
       -rwxr-xr-x. 1 root root       2669 Mar 25 12:05 startup.sh
       -rwxr-xr-x. 1 root root       2031 Mar 25 12:05 upgrade.sh

启动CloudCanal

  • 执行启动命令: sh startup.sh

  • 当终端出现 cloudcanal start 时，即启动成功

确认启动成功

  • 启动过程将耗时 1 分钟左右，访问控制台 http://{您部署机器的ip}:8111 正确登录并开始操作

使用CloudCanal

使用提示（必读）

为了方便您一开始快速体验 CloudCanal ，我们已自动帮您做好了一些初始化的工作

  • 请务必使用提供的默认账号登入，方便您快速体验
  • 如遇需要发送短信的场景，先点击获取验证码，然后输入短信验证码 777777 即可
  • 试用用户
  • 试用密码
    • clougence2021
  • 默认已添加测试 MySQL，并已准备好表和数据
    • cloudcanal_test_a(源端)
    • cloudcanal_test_b(目标端)
  • 默认已添加一台运行机器，用于执行具体的数据同步任务

登录

使用默认提供的账号密码登录 CloudCanal

查看机器状态

  • 机器管理 > 机器列表

    • 进入机器列表页，查看默认机器的健康状态。如果机器不健康，则需要查看部署的sidecar是否正常启动

查看数据源

  • 进入 数据源管理 页面，查看默认数据源是否存在，也可以自己添加数据源。

创建任务

  • 任务管理 > 创建任务

  • 选择 任务运行集群

  • 选择源和目标数据源并点击 测试连接

  • 选择需要 迁移同步或校验的数据库

  • 单机下一步

  • 选择数据业务类型 数据同步，默认附带 数据初始化

  • 选择 规格 ,默认平衡型 2G 规格即可

  • 点击下一步

  • 选择表，默认即可

  • 点击下一步

  • 选择列，默认即可

  • 点击下一步

  • 确认创建任务

任务正常运行

  • 任务创建成功后，会默认进行结构迁移(可选)、全量迁移、增量同步，进度条会逐步发生变化