全新安装(Linux/MacOS)

简述

本文档主要介绍如何在 Linux/MacOS 系统下，全新安装 CloudCanal。

非 Linux/Unix 系列系统，高可用部署，版本升级请参考本文档所在目录其他文档。

请务必完整阅读本文，以免影响使用体验

安装步骤

1. 硬件和系统准备

操作系统
- CentOS
- Ubuntu
- MacOS
CPU架构
- x86
- arm64v8 (请单独联系我们获取安装包)
- [TIPS] 不支持 vmware、virtualbox 和 windows 的 linux 子系统
最低配置
- 2 核cpu
- 6GB 内存

2. 环境准备

部署前请确保以下端口未被占用(安装脚本将会预检)

组件	端口	用途
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）

3. 软件准备

安装 Chrome 浏览器 ,用来控制台访问
安装 docker (版本 17.x.x 及以上)
- 参考文档 https://docs.docker.com/engine/install/

安装 docker-compose

官方文档安装 https://docs.docker.com/compose/install/#alternative-install-options

国内镜像站安装

# x86
curl -L https://get.daocloud.io/docker/compose/releases/download/1.28.5/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose

# arm64
curl -L https://get.daocloud.io/docker/compose/releases/download/v2.14.1/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 分配内存

安装 7z 解压工具

 # centos
 sudo yum install -y p7zip p7zip-plugins
 # ubuntu
 sudo apt-get install p7zip-full p7zip-rar
 # MacOS
 brew install 7z

安装其他预检相关工具

 # centos
 sudo yum install -y lsof
 # ubuntu
 sudo apt-get -y install lsof

4. 安装包准备

登录官方网站点击立即使用按钮
点击弹窗中的下载私有部署版按钮
解压缩安装包
```
7z x cloudcanal.7z -o./cloudcanal_home
```

解压内容如下

镜像
- images 目录下四个 tar 结尾的压缩文件
docker 容器编排文件
- docker-compose.yml 文件

脚本

重要脚本	用途
./install.sh	全新安装 CloudCanal, 其中会调用 ./scripts/precheck_install.sh 做预检
./upgrade.sh	升级 CloudCanal, 清理相关内容后调用 install.sh 安装
./uninstall.sh	卸载 CloudCanal，包含停止容器、删除镜像、删除元数据库、删除相应的卷等操作
./stop.sh	停止 CloudCanal 相关容器运行
./start.sh	启动 CloudCanal 相关容器
./restart.sh	重启 CloudCanal 相关容器
./install_one_node.sh	新部署一个同步节点, 具体参考高可用部署文档
./scripts/precheck_install.sh	预检脚本，检查依赖软件安装状况，端口占用状况等
other	其他辅助脚本