TiUP 是 TiDB 4.0 版本引入的集群运维工具,TiUP cluster 是 TiUP 提供的使用 Golang 编写的集群管理组件,通过 TiUP cluster 组件就可以进行日常的运维工作,包括部署、启动、关闭、销毁、弹性扩缩容、升级 TiDB 集群,以及管理 TiDB 集群参数。
目前 TiUP 可以支持部署 TiDB、TiFlash、TiDB Binlog、TiCDC 以及监控系统。本文将介绍不同集群拓扑的具体部署步骤。
本次演示在线安装,仅适用于快速上手体验,不适用于生产环境:
1.TiDB部署本地测试集群(支持 Mac 和 Linux)
2.在单机上模拟部署生产环境集群(支持 Linux)
3. 生产部署可参考官网文档:PingCAP官方文档
适用场景:利用本地 Mac 或者单机 Linux 环境快速部署 TiDB 测试集群,体验 TiDB 集群的基本架构,以及TiDB、TiKV、PD、监控等基础组件的运行。
1.下载并安装TiUP
curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh
2.声明全局环境变量
#source
source /root/.bash_profile
3.在当前 session 执行以下命令启动集群
运行最新版本的TiDB集群,其中TiDB、TiKV、PD和TiFlash实例个1个
tiup playground
也可以指定TiDB版本以及各组件实例个数:
tiup playground v5.0.0 --db 2 --pd 3 --kv 3 --monitor
上述命令会在本地下载并启动某个版本的集群(例如 v5.0.0),--monitor 表示同时部署监控组件。
最新版本可以通过执行 tiup list tidb 来查看。
注意:
(1).以这种方式执行的 playground,在结束部署测试后 TiUP 会清理掉原集群数据,重新执行该命令后会得到一个全新的集群。
(2).默认监听 127.0.0.1,服务仅本地可访问。若需要使服务可被外部访问,可使用 --host 参数指定监听网卡绑定外部可访问的 IP
4.新开启一个 session 以访问 TiDB 数据库
使用 TiUP client 连接 TiDB:
tiup client
也可使用 MySQL 客户端连接 TiDB:
mysql --host 127.0.0.1 --port 4000 -u root
mysql的安装可以参考:CentOS使用yum在线安装mysql5.7
5.测试完成之后,可以通过执行以下步骤来清理集群
tiup clean --all
适用场景:希望用单台 Linux 服务器,体验 TiDB 最小的完整拓扑的集群,并模拟生产环境下的部署步骤。
目标:如何参照 TiUP 最小拓扑的一个 YAML 文件部署 TiDB 集群。
部署前的准备:
1.CentOS 7.3 及以上版本
2.Linux 操作系统开放外网访问,用于下载 TiDB 及相关软件安装包
3.虚机内存4G以上,4核。(使用2G在部署单机模拟生产环境时失败)
最小规模的 TiDB 集群拓扑:
注意:下表中拓扑实例的 IP 为示例 IP。在实际部署时,请替换为实际的 IP。
部署主机软件和环境要求:
(1) 部署需要使用部署主机的 root 用户及密码
(2) 部署主机关闭防火墙或者开放 TiDB 集群的节点间所需端口
(3) 目前 TiUP 支持在x86_64 (AMD64 和 ARM) 架构上部署 TiDB 集群
实施部署:
1.下载并安装 TiUP:
curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh
2.声明全局环境变量:
source /root/.bash_profile
3.安装 TiUP 的 cluster 组件:
tiup cluster
4.如果机器已经安装 TiUP cluster,需要更新软件版本:
tiup update --self && tiup update cluster
5.由于模拟多机部署,需要通过 root 用户调大 sshd 服务的连接数限制:
5.1 修改 /etc/ssh/sshd_config 将 MaxSessions 调至 20。
5.2 重启 sshd 服务:
systemctl start sshd.service
6.创建并启动集群
使用tiup cluster template > topo.yaml创建,或直接创建topo.yaml
vi topo.yaml
配置模板如下:
# # Global variables are applied to all deployments and used as the default value of
# # the deployments if a specific deployment value is missing.
global:
user: "tidb"
ssh_port: 22
deploy_dir: "/tidb-deploy"
data_dir: "/tidb-data"
# # Monitored variables are applied to all the machines.
monitored:
node_exporter_port: 9100
blackbox_exporter_port: 9115
server_configs:
tidb:
log.slow-threshold: 300
tikv:
readpool.storage.use-unified-pool: false
readpool.coprocessor.use-unified-pool: true
pd:
replication.enable-placement-rules: true
replication.location-labels: ["host"]
tiflash:
logger.level: "info"
pd_servers:
- host: 10.0.1.1
tidb_servers:
- host: 10.0.1.1
tikv_servers:
- host: 10.0.1.1
port: 20160
status_port: 20180
config:
server.labels: { host: "logic-host-1" }
- host: 10.0.1.1
port: 20161
status_port: 20181
config:
server.labels: { host: "logic-host-2" }
- host: 10.0.1.1
port: 20162
status_port: 20182
config:
server.labels: { host: "logic-host-3" }
tiflash_servers:
- host: 10.0.1.1
monitoring_servers:
- host: 10.0.1.1
grafana_servers:
- host: 10.0.1.1
7.执行集群部署命令:
#tiup cluster deploy ./topo.yaml --user root -p
tiup cluster deploy tidb-test v5.0.0 ./topo.yaml --user root -p
8.启动集群:
#tiup cluster start
tiup cluster start tidb-test
9.访问集群:
安装 MySQL 客户端。如果已安装 MySQL 客户端则可跳过这一步骤,
若未安装,安装可以参考:CentOS使用yum在线安装mysql5.7
9.1访问 TiDB 数据库,密码为空:
mysql -h 10.0.1.1 -P 4000 -u root
9.2访问 TiDB 的 Grafana 监控:
通过 http://{grafana-ip}:3000 访问集群 Grafana 监控页面,默认用户名和密码均为 admin。
9.3访问 TiDB 的 Dashboard:
通过 http://{pd-ip}:2379/dashboard 访问集群 TiDB Dashboard 监控页面,默认用户名为 root,密码为空
9.4执行以下命令确认当前已经部署的集群列表
tiup cluster list
9.5 执行以下命令查看集群的拓扑结构和状态:
tiup cluster display tidb-test
TiUP常用命令
#查看TiUP cluster组件版本
tiup --binary cluster
#检查和自动修复集群存在的潜在风险
tiup cluster check ./topo.yaml --apply --user root -p
#部署TiDB集群
tiup cluster deploy tidb-test v5.0.0 ./topo.yaml --user root -p
#查看TiUP管理的集群情况
tiup cluster list
#检查tidb-test集群情况
tiup cluster display tidb-test
#启动集群
tiup cluster start tidb-test
#关闭集群
tiup cluster stop tidb-test
#连接到TiDB
mysql -h 虚机IP -P 4000 -u root
参考文档:PingCAP官方文档 TiDB 数据库快速上手指南