全新安装(Windows)
请务必完整阅读本文,尤其是使用教程(必读)章节的内容,避免由于操作不当影响体验cloudcanal
本文主要介绍如何在 Windows 下安装 CloudCanal。
MacOS/Linux 请参考全新安装(Linux/MacOS)
安装步骤
1. 环境准备
部署前请确保以下端口未被占用(安装脚本将会预检)
组件 端口 用途 cloudcanal-mysql 25000 元数据库 mysql 对外映射端口 cloudcanal-prometheus 9090 prometheuse 监控指标查询端口 cloudcanal-console 7007 console 和 sidecar 通信端口 cloudcanal-console 8111 console web控制台端口 cloudcanal-sidecar 18787 任务 debug 端口(e.g.,自定义代码 debug)
- 机器规格建议
- CPU架构
- x86
- [TIPS] 不支持 vmware、virtualbox 和 windows 的 linux 子系统
- 最低配置
- 2 核cpu
- 6GB 内存
- CPU架构
2. Docker 准备
安装 docker 和 docker-compose
安装完毕后,设置 -> Resouces -> ADVANCED下,建议将内存限制至少调至 6GB
- CloudCanal 预检将要求至少 6GB 容器内存,默认 docker 内存分配为 2GB
3. 下载安装包
- 登录官方网站点击立即使用按钮
- 点击弹窗中的下载私有部署版按钮
4. 解压安装包
安装 7z 解压缩软件,并解压 CloudCanal 安装包到某一个目录
https://www.7-zip.org/download.html
解压目录内容包括
- 镜像
- images 目录下四个 tar 结尾的压缩文件
- docker 容器编排
- docker-compose.yml 文件
- 脚本
- 启动、停止和重启等脚本(面向 linux 系统)
- 镜像
5. 启动 CloudCanal
在 Windows CMD 窗口中,进入解压后目录,逐步输入以下命令
# 创建mysql的volume
docker volume create clougence_mysql_volume
# 将console镜像文件load至本地docker中
docker load --input console.tar ;
# 将mysql镜像文件load到本地docker中
docker load --input mysql.tar ;
# 将sidecar镜像文件load到本地docker中
docker load --input sidecar.tar ;
# 将prometheus镜像文件load到本地docker中
docker load --input prometheus.tar
# 用docker创建cloudcanal使用的网络
docker network create --subnet 172.31.238.0/24 --gateway 172.31.238.1 cloudcanal-network
# 用docker-compose命令启动
docker-compose up
6. 确认启动成功
7. 开始使用
使用浏览器登陆控制台
http://{your deploy CloudCanal ip}:8111
使用试用账号登陆
- 账号:test@clougence.com
- 密码:clougence2021
使用默认验证码
- 如遇到使用默认验证码场景,请使用 777777 默认验证码即可
使用体验资源
- 已添加的测试 MySQL
- cloudcanal_test_a
- cloudcanal_test_b
- 已添加的迁移同步节点
- 已添加的测试 MySQL
具体参见快速上手文档
8. 申请免费许可证并激活
进入控制台,点击弹出框 去激活 按钮,或点击右上角 未激活 文本
弹窗显示 申请码,点击 复制 按钮或直接选中复制文本
登录官网 ,CloudCanal 产品页点击 获取许可证
将 申请码 填入
点击 社区版 选项卡
点击 立即购买 , 此时会 0 元下单
页面右上角头像 > 我的订单,获取许可证
回到产品激活页面,将获取到的 授权码 填入空格中,点击激活
如正常激活,页面右上角将展示简要信息,点击 已激活 文本,可看到详细信息
无论在 已激活 或 未激活 状态,都可以再次 申请免费许可证 重新激活以延长时间或者增加使用容量
许可证详细规则说明,请浏览 许可证 规则 文档
FAQ
启动mysql容器报错 cannot start a stopped process: unknown
docker-compose logs 查看mysql服务的日志可以看到报错,找不到符号
undefined symbol: seccomp_api_get
这个是因为Linux操作系统有个lib版本低于2.4导致,升级下版本
yum update libseccomp
mount through procfd: possibly malicious path detected
如果采用virtual box这样的虚拟机,使用docker时会遇到这样的问题。当前不支持在虚拟机上执行
manifest for clougence not found manifest unknow
这种一般是没有正常安装镜像或者历史老版本残留数据影响导致,请先通过scripts中的delete_all脚本清理镜像、容器、卷然后再执行startup.sh脚本