https://docs.pingcap.com/zh/tidb/stable/quick-start-with-tidb#tidb-%E6%95%B0%E6%8D%AE%E5%BA%93%E5%BF%AB%E9%80%9F%E4%B8%8A%E6%89%8B%E6%8C%87%E5%8D%97
本指南介绍如何快速上手体验 TiDB 数据库。对于非生产环境,你可以选择以下任意一种方式部署 TiDB 数据库: [size=0.875]
注意
本指南中的 TiDB 部署方式仅适用于快速上手体验,不适用于生产环境。
要快速了解 TiUP 的基本功能、使用 TiUP 快速搭建 TiDB 集群的方法与连接 TiDB 集群并执行 SQL 的方法,建议先观看下面的培训视频(时长 15 分钟)。注意本视频只作为学习参考,如需了解 TiUP 的具体使用方法和 TiDB 快速上手具体操作步骤,请以文档内容为准。 部署本地测试集群- 适用场景:利用本地 macOS 或者单机 Linux 环境快速部署 TiDB 测试集群,体验 TiDB 集群的基本架构,以及 TiDB、TiKV、PD、监控等基础组件的运行。
TiDB 是一个分布式系统。最基础的 TiDB 测试集群通常由 2 个 TiDB 实例、3 个 TiKV 实例、3 个 PD 实例和可选的 TiFlash 实例构成。通过 TiUP Playground,可以快速搭建出上述的一套基础测试集群,步骤如下: 下载并安装 TiUP。 curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh
安装完成后会提示如下信息: Successfully set mirror to https://tiup-mirrors.pingcap.comDetected shell: zshShell profile: /Users/user/.zshrc/Users/user/.zshrc has been modified to add tiup to PATHopen a new terminal or source /Users/user/.zshrc to use itInstalled path: /Users/user/.tiup/bin/tiup===============================================Have a try: tiup playground===============================================
声明全局环境变量。 [size=0.875]
注意
TiUP 安装完成后会提示 Shell profile 文件的绝对路径。在执行以下 source 命令前,需要将 ${your_shell_profile} 修改为 Shell profile 文件的实际位置。
source ${your_shell_profile}
在当前 session 执行以下命令启动集群。 直接执行 tiup playground 命令会运行最新版本的 TiDB 集群,其中 TiDB、TiKV、PD 和 TiFlash 实例各 1 个: tiup playground
也可以指定 TiDB 版本以及各组件实例个数,命令类似于: tiup playground v7.5.0 --db 2 --pd 3 --kv 3
上述命令会在本地下载并启动某个版本的集群(例如 v7.5.0)。最新版本可以通过执行 tiup list tidb 来查看。运行结果将显示集群的访问方式: CLUSTER START SUCCESSFULLY, Enjoy it ^-^To connect TiDB: mysql --comments --host 127.0.0.1 --port 4001 -u root -p (no password)To connect TiDB: mysql --comments --host 127.0.0.1 --port 4000 -u root -p (no password)To view the dashboard: http://127.0.0.1:2379/dashboardPD client endpoints: [127.0.0.1:2379 127.0.0.1:2382 127.0.0.1:2384]To view the Prometheus: http://127.0.0.1:9090To view the Grafana: http://127.0.0.1:3000
[size=0.875]
注意
- 支持 v5.2.0 及以上版本的 TiDB 在 Apple M1 芯片的机器上运行 tiup playground。
- 以这种方式执行的 playground,在结束部署测试后 TiUP 会清理掉原集群数据,重新执行该命令后会得到一个全新的集群。
- 若希望持久化数据,可以执行 TiUP 的 --tag 参数:tiup --tag <your-tag> playground ...,详情参考 TiUP 参考手册。
新开启一个 session 以访问 TiDB 数据库。 使用 TiUP client 连接 TiDB: tiup client
也可使用 MySQL 客户端连接 TiDB: mysql --host 127.0.0.1 --port 4000 -u root
测试完成之后,可以通过执行以下步骤来清理集群:
[size=0.875]
注意
TiUP Playground 默认监听 127.0.0.1,服务仅本地可访问;若需要使服务可被外部访问,可使用 --host 参数指定监听网卡绑定外部可访问的 IP。
在单机上模拟部署生产环境集群- 适用场景:希望用单台 Linux 服务器,体验 TiDB 最小的完整拓扑的集群,并模拟生产环境下的部署步骤。
本节介绍如何参照 TiUP 最小拓扑的一个 YAML 文件部署 TiDB 集群。 准备环境开始部署 TiDB 集群前,准备一台部署主机,确保其软件满足需求: - 推荐安装 CentOS 7.3 及以上版本
- 运行环境可以支持互联网访问,用于下载 TiDB 及相关软件安装包
最小规模的 TiDB 集群拓扑包含以下实例: [size=0.875]
注意
下表中拓扑实例的 IP 为示例 IP。在实际部署时,请替换为实际的 IP。
实例 个数 IP 配置
TiKV 3 10.0.1.1
10.0.1.1
10.0.1.1 避免端口和目录冲突
TiDB 1 10.0.1.1 默认端口
全局目录配置
PD 1 10.0.1.1 默认端口
全局目录配置
TiFlash 1 10.0.1.1 默认端口
全局目录配置
Monitor 1 10.0.1.1 默认端口
全局目录配置 部署主机软件和环境要求如下: - 部署需要使用部署主机的 root 用户及密码
- 部署主机关闭防火墙或者开放 TiDB 集群的节点间所需端口
- 目前 TiUP Cluster 支持在 x86_64(AMD64)和 ARM 架构上部署 TiDB 集群
- 在 AMD64 架构下,建议使用 CentOS 7.3 及以上版本 Linux 操作系统
- 在 ARM 架构下,建议使用 CentOS 7.6 1810 版本 Linux 操作系统
实施部署[size=0.875]
注意
你可以使用 Linux 系统的任一普通用户或 root 用户登录主机,以下步骤以 root 用户为例。
下载并安装 TiUP: curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh
声明全局环境变量: [size=0.875]
注意
TiUP 安装完成后会提示对应 Shell profile 文件的绝对路径。在执行以下 source 命令前,需要将 ${your_shell_profile} 修改为 Shell profile 文件的实际位置。
source ${your_shell_profile}
安装 TiUP 的 cluster 组件: tiup cluster
如果机器已经安装 TiUP cluster,需要更新软件版本: tiup update --self && tiup update cluster
由于模拟多机部署,需要通过 root 用户调大 sshd 服务的连接数限制: 创建并启动集群 按下面的配置模板,编辑配置文件,命名为 topo.yaml,其中: - user: "tidb":表示通过 tidb 系统用户(部署会自动创建)来做集群的内部管理,默认使用 22 端口通过 ssh 登录目标机器
- replication.enable-placement-rules:设置这个 PD 参数来确保 TiFlash 正常运行
- host:设置为本部署主机的 IP
配置模板如下: # # 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: 9115server_configs: tidb: instance.tidb_slow_log_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.1tidb_servers: - host: 10.0.1.1tikv_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.1monitoring_servers: - host: 10.0.1.1grafana_servers: - host: 10.0.1.1
执行集群部署命令: tiup cluster deploy <cluster-name> <version> ./topo.yaml --user root -p
按照引导,输入”y”及 root 密码,来完成部署: Do you want to continue? [y/N]: yInput SSH password:
启动集群: tiup cluster start <cluster-name>
访问集群:
探索更多如果你刚刚部署好一套 TiDB 本地测试集群,你可以继续: 如果你准备好在生产环境部署 TiDB,你可以继续: 如果你想使用 TiFlash 作为数据分析的解决方案,可参阅以下文档:
[size=0.875]TiDB 数据库快速上手指南[size=0.875]更新于 2023/12/1 16:19:10: [size=0.875]bump version to 7.5.0 (#15436) (#15591)
|