跳到主要内容

全新安装(Docker Linux/MacOS)

本文主要介绍如何在 Linux/MacOS 操作系统下安装 CloudCanal Docker 版。

Windows 操作系统请参考全新安装(Docker Windows)。

安装步骤​

硬件和系统准备​

  • 操作系统
    • CentOS/RHEL
    • Ubuntu
    • MacOS
  • CPU架构
    • x86
    • arm64v8
    • [TIPS] 不支持 vmware、virtualbox 和 windows 的 linux 子系统
  • 最低配置
    • 2 核cpu
    • 6GB 内存

环境准备​

  • 部署前请确保以下端口未被占用

    组件端口用途
    cloudcanal-mysql25000元数据库 mysql 对外映射端口
    cloudcanal-prometheus19090prometheuse 监控指标查询端口
    cloudcanal-console7007console 和 sidecar 通信端口
    cloudcanal-console8111console web控制台端口
    cloudcanal-sidecar18787任务 debug 端口（e.g.,自定义代码 debug）

软件准备​

  • 安装 Chrome 浏览器

  • 安装 基础工具

    ## centos / rhel
    sudo yum update
    sudo yum install -y yum-utils
    sudo yum install -y lsof
    sudo yum install -y bc
    sudo yum install -y p7zip p7zip-plugins 

    ## ubuntu
    sudo apt update
    sudo apt install apt-transport-https ca-certificates curl gnupg-agent software-properties-common
    sudo apt-get install -y lsof
    sudo apt-get install -y bc
    sudo apt-get install -y p7zip-full

    ## MacOS
    ## download 7-zip from official website and install

安装包准备​

  • 登录官方网站，点击下载私有部署版按钮，获取 软件包下载连接 downloadtgz

  • 下载安装包

    wget -cO cloudcanal.7z "${软件包下载连接}"

  • 解压安装包

    7z x cloudcanal.7z -o./cloudcanal_home
    cd cloudcanal_home/install_on_docker

  • 解压目录内容包括

    • 镜像
      • images 目录下四个 tar 结尾的压缩文件
    • docker 容器编排文件（位置：解压目录/install_on_docker/）
      • docker-compose.yml 文件
    • 脚本（位置：解压目录/install_on_docker/）
    脚本用途
    ./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预检脚本，检查依赖软件安装状况，端口占用状况等
    ./scripts/initDB.sh更新 CloudCanal 元数据库
    ./support/install_xxx_docker.sh辅助安装 docker 和 docker-compose 脚本
    other其他辅助脚本

运行环境准备​

  • 安装 docker 和 docker-compose,可参考 官方文档 (版本 17.x.x 及以上)，也可直接使用安装包提供的脚本

    ## centos / rhel,进入 install_on_docker 目录
    sh ./support/install_centos_docker.sh

    ## ubuntu,进入 install_on_docker 目录
    bash ./support/install_ubuntu_docker.sh

    ## amazon linux,进入 install_on_docker 目录
    sh ./support/install_amazon_linux_docker.sh
     
    ## MacOS,参考[docker MacOS 安装文档](https://docs.docker.com/desktop/install/mac-install/)

  • MacOS 系统请为 Docker 分配内存 f0f8aece-be13-44f6-be2b-d5fecd9a7b67-image.png

安装 CloudCanal​

  • 执行安装脚本

    ## centos / rhel / MacOS
    sh install.sh 
     
    ## ubuntu
    bash install.sh

    ## amazon linux
    sudo sh install.sh

  • 出现如下标识即安装成功 7b00e562-cd45-4905-a626-1356503d8213-image.png

开始使用​