- 关于 TiDB
- 快速上手
- 应用开发
- 概览
- 快速开始
- 示例程序
- 连接到 TiDB
- 数据库模式设计
- 数据写入
- 数据读取
- 事务
- 优化 SQL 性能
- 故障诊断
- 引用文档
- 云原生开发环境
- 部署标准集群
- 数据迁移
- 运维操作
- 监控与告警
- 故障诊断
- 性能调优
- 优化手册
- 配置调优
- SQL 性能调优
- SQL 性能调优概览
- 理解 TiDB 执行计划
- SQL 优化流程
- 控制执行计划
- 教程
- 同城多中心部署
- 两地三中心部署
- 同城两中心部署
- 读取历史数据
- 使用 Stale Read 功能读取历史数据(推荐)
- 使用系统变量
tidb_snapshot
读取历史数据
- 最佳实践
- Placement Rules 使用文档
- Load Base Split 使用文档
- Store Limit 使用文档
- TiDB 工具
- 功能概览
- 适用场景
- 工具下载
- TiUP
- 文档地图
- 概览
- 术语及核心概念
- TiUP 组件管理
- FAQ
- 故障排查
- TiUP 命令参考手册
- 命令概览
- TiUP 命令
- TiUP Cluster 命令
- TiUP Cluster 命令概览
- tiup cluster audit
- tiup cluster check
- tiup cluster clean
- tiup cluster deploy
- tiup cluster destroy
- tiup cluster disable
- tiup cluster display
- tiup cluster edit-config
- tiup cluster enable
- tiup cluster help
- tiup cluster import
- tiup cluster list
- tiup cluster patch
- tiup cluster prune
- tiup cluster reload
- tiup cluster rename
- tiup cluster replay
- tiup cluster restart
- tiup cluster scale-in
- tiup cluster scale-out
- tiup cluster start
- tiup cluster stop
- tiup cluster template
- tiup cluster upgrade
- TiUP DM 命令
- TiUP DM 命令概览
- tiup dm audit
- tiup dm deploy
- tiup dm destroy
- tiup dm disable
- tiup dm display
- tiup dm edit-config
- tiup dm enable
- tiup dm help
- tiup dm import
- tiup dm list
- tiup dm patch
- tiup dm prune
- tiup dm reload
- tiup dm replay
- tiup dm restart
- tiup dm scale-in
- tiup dm scale-out
- tiup dm start
- tiup dm stop
- tiup dm template
- tiup dm upgrade
- TiDB 集群拓扑文件配置
- DM 集群拓扑文件配置
- TiUP 镜像参考指南
- TiUP 组件文档
- PingCAP Clinic 诊断服务 (Technical Preview)
- TiDB Operator
- Dumpling
- TiDB Lightning
- TiDB Data Migration
- 关于 Data Migration
- 快速开始
- 部署 DM 集群
- 入门指南
- 进阶教程
- 运维管理
- 参考手册
- 使用示例
- 异常解决
- 版本发布历史
- Backup & Restore (BR)
- TiDB Binlog
- TiCDC
- TiUniManager
- sync-diff-inspector
- TiSpark
- 参考指南
- 架构
- 监控指标
- 安全加固
- 权限
- SQL
- SQL 语言结构和语法
- SQL 语句
ADD COLUMN
ADD INDEX
ADMIN
ADMIN CANCEL DDL
ADMIN CHECKSUM TABLE
ADMIN CHECK [TABLE|INDEX]
ADMIN SHOW DDL [JOBS|QUERIES]
ADMIN SHOW TELEMETRY
ALTER DATABASE
ALTER INDEX
ALTER INSTANCE
ALTER PLACEMENT POLICY
ALTER TABLE
ALTER TABLE COMPACT
ALTER USER
ANALYZE TABLE
BACKUP
BATCH
BEGIN
CHANGE COLUMN
CHANGE DRAINER
CHANGE PUMP
COMMIT
CREATE [GLOBAL|SESSION] BINDING
CREATE DATABASE
CREATE INDEX
CREATE PLACEMENT POLICY
CREATE ROLE
CREATE SEQUENCE
CREATE TABLE LIKE
CREATE TABLE
CREATE USER
CREATE VIEW
DEALLOCATE
DELETE
DESC
DESCRIBE
DO
DROP [GLOBAL|SESSION] BINDING
DROP COLUMN
DROP DATABASE
DROP INDEX
DROP PLACEMENT POLICY
DROP ROLE
DROP SEQUENCE
DROP STATS
DROP TABLE
DROP USER
DROP VIEW
EXECUTE
EXPLAIN ANALYZE
EXPLAIN
FLASHBACK TABLE
FLUSH PRIVILEGES
FLUSH STATUS
FLUSH TABLES
GRANT <privileges>
GRANT <role>
INSERT
KILL [TIDB]
LOAD DATA
LOAD STATS
MODIFY COLUMN
PREPARE
RECOVER TABLE
RENAME INDEX
RENAME TABLE
REPLACE
RESTORE
REVOKE <privileges>
REVOKE <role>
ROLLBACK
SELECT
SET DEFAULT ROLE
SET [NAMES|CHARACTER SET]
SET PASSWORD
SET ROLE
SET TRANSACTION
SET [GLOBAL|SESSION] <variable>
SHOW [BACKUPS|RESTORES]
SHOW ANALYZE STATUS
SHOW [GLOBAL|SESSION] BINDINGS
SHOW BUILTINS
SHOW CHARACTER SET
SHOW COLLATION
SHOW [FULL] COLUMNS FROM
SHOW CONFIG
SHOW CREATE PLACEMENT POLICY
SHOW CREATE SEQUENCE
SHOW CREATE TABLE
SHOW CREATE USER
SHOW DATABASES
SHOW DRAINER STATUS
SHOW ENGINES
SHOW ERRORS
SHOW [FULL] FIELDS FROM
SHOW GRANTS
SHOW INDEX [FROM|IN]
SHOW INDEXES [FROM|IN]
SHOW KEYS [FROM|IN]
SHOW MASTER STATUS
SHOW PLACEMENT
SHOW PLACEMENT FOR
SHOW PLACEMENT LABELS
SHOW PLUGINS
SHOW PRIVILEGES
SHOW [FULL] PROCESSSLIST
SHOW PROFILES
SHOW PUMP STATUS
SHOW SCHEMAS
SHOW STATS_HEALTHY
SHOW STATS_HISTOGRAMS
SHOW STATS_META
SHOW STATUS
SHOW TABLE NEXT_ROW_ID
SHOW TABLE REGIONS
SHOW TABLE STATUS
SHOW [FULL] TABLES
SHOW [GLOBAL|SESSION] VARIABLES
SHOW WARNINGS
SHUTDOWN
SPLIT REGION
START TRANSACTION
TABLE
TRACE
TRUNCATE
UPDATE
USE
WITH
- 数据类型
- 函数与操作符
- 聚簇索引
- 约束
- 生成列
- SQL 模式
- 表属性
- 事务
- 视图
- 分区表
- 临时表
- 缓存表
- 字符集和排序
- Placement Rules in SQL
- 系统表
mysql
- INFORMATION_SCHEMA
- Overview
ANALYZE_STATUS
CLIENT_ERRORS_SUMMARY_BY_HOST
CLIENT_ERRORS_SUMMARY_BY_USER
CLIENT_ERRORS_SUMMARY_GLOBAL
CHARACTER_SETS
CLUSTER_CONFIG
CLUSTER_HARDWARE
CLUSTER_INFO
CLUSTER_LOAD
CLUSTER_LOG
CLUSTER_SYSTEMINFO
COLLATIONS
COLLATION_CHARACTER_SET_APPLICABILITY
COLUMNS
DATA_LOCK_WAITS
DDL_JOBS
DEADLOCKS
ENGINES
INSPECTION_RESULT
INSPECTION_RULES
INSPECTION_SUMMARY
KEY_COLUMN_USAGE
METRICS_SUMMARY
METRICS_TABLES
PARTITIONS
PLACEMENT_POLICIES
PROCESSLIST
REFERENTIAL_CONSTRAINTS
SCHEMATA
SEQUENCES
SESSION_VARIABLES
SLOW_QUERY
STATISTICS
TABLES
TABLE_CONSTRAINTS
TABLE_STORAGE_STATS
TIDB_HOT_REGIONS
TIDB_HOT_REGIONS_HISTORY
TIDB_INDEXES
TIDB_SERVERS_INFO
TIDB_TRX
TIFLASH_REPLICA
TIKV_REGION_PEERS
TIKV_REGION_STATUS
TIKV_STORE_STATUS
USER_PRIVILEGES
VIEWS
METRICS_SCHEMA
- UI
- CLI
- 命令行参数
- 配置文件参数
- 系统变量
- 存储引擎
- 遥测
- 错误码
- 通过拓扑 label 进行副本调度
- 常见问题解答 (FAQ)
- 版本发布历史
- 术语表
TiUniManager 快速操作指南
本文档介绍 TiUniManager 的常见操作场景以及基本的集群操作,包括将主机节点加入 TiDB 集群、创建 TiDB 集群、删除集群、接管集群。
在阅读本文档前,你需要先阅读 TiUniManager 安装和运维手册 完成 TiUniManager 的安装。
将主机节点加入 TiDB 集群
系统初始化或者扩容机器时,系统管理员需将主机信息导入 TiUniManager 平台,TiUniManager 将导入的机器加入到集群中,由平台统一管理。
前置条件
将主机节点加入 TiDB 集群前,需要保证:
- 已经登录 TiUniManager 控制台
- 已安装主机的操作系统和所依赖的软件,并通过测试
- 你需要按照主机模板完整、正确地填写字段信息。详情参见本节中主机模板字段说明。
- 导入主机时,TiDB 会对主机进行检查,参见 TiDB 环境与系统配置检查。
TiUniManager 中控机通过 SSH 连接主机,默认连接端口为 22
。如果环境中 SSH 端口不为默认的 22
,可通过 OpenAPI 修改 config_default_ssh_port
参数来配置主机的默认登陆端口,该参数默认值为 22
。以下示例通过 OpenAPI 修改 config_default_ssh_port
参数的值,从而修改主机的默认登陆端口:
登录 TiUniManager 获取用户 Token。
curl -X 'POST' \ 'http://172.16.6.206:4180/api/v1/user/login' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "userName": "admin", "userPassword": "admin" }'
注意你需要将以上命令中
172.16.6.206:4180
替换为实际环境中 TiUniManager 中控机的 IP 地址和 WebServer 服务端口。查看
config_default_ssh_port
的参数值。curl -X GET "http://172.16.6.206:4100/api/v1/config/?configKey=config_default_ssh_port" -H "Authorization: Bearer 6ea768e4-c0ec-4d48-b401-0f114ddc994c"
将
config_default_ssh_port
的值修改为newValue
。curl -X POST "http://172.16.6.206:4100/api/v1/config/update" -d "{ \"configKey\": \"config_default_ssh_port\", \"configValue\": \"newValue\"}" -H "Authorization: Bearer 6ea768e4-c0ec-4d48-b401-0f114ddc994c"
操作步骤
- 进入资源管理页面。
- 点击导入主机按钮。
- 点击下载主机模板按钮。
- 双击打开模板,并按照模板填入相应信息并保存。
- 点击上传按钮,选择步骤 5 中编辑的文件,并上传该文件。
- 点击确认按钮,确认导入主机信息。
主机模板字段说明
Hostname | 主机名 |
---|---|
IP | 主机 IP 地址 |
Login username | 主机用户名(选填, 当通过用户名密码方式导入主机时,才需要填写) |
Login password | 主机密码(选填, 当通过用户名密码方式导入主机时,才需要填写) |
Region | 区域 ID (产品初始化时设定的 Region ID) |
Zone | 可用区 ID (产品初始化时设定的 Zone ID) |
Rack | 机架 ID (产品初始化时设定的 Rack ID) |
Arch | 体系架构 |
OS Version | 操作系统版本 |
Kernel | 内核版本 |
vCPU | CPU 核数 |
Memory | 内存大小 |
NIC | 网卡规格 |
Cluster Purpose | 区分主机用来部署什么类型的集群,包括 TiDB、DM、TiUniManager |
Host Purpose | 主机用途:用来区分部署的组件类型,包括:Compute、Storage、Schedule 三种用途。多种用途以逗号 “,” 连接,例如 ‘Compute,Storage,Schedule’ |
Disk Type | 磁盘类型,包括:NVMe SSD、SSD、SATA 三种类型 |
Disks | 磁盘信息,包括磁盘名称、容量、状态、路径,示例:{"name": "sda","capacity": 256,"status": "Available", "path": "/mnt/sda"} |
如果通过用户名密钥方式导入主机,需要在 TiUniManager 安装前配置用户名和密钥路径,参见指定 TiUniManager 中控机登录 TiDB 资源机的账户和密钥。
创建集群
TiUniManager 部署完成后,你可以通过 TiUniManager 创建 TiDB 集群,并自定义集群配置。
前置条件
- 已登录 TiUniManager 控制台
- 已完成主机资源导入
操作步骤
- 进入集群管理 > 集群页面。
- 点击创建集群按钮,跳转至创建实例的页面。
- 选择集群创建模式。
- 选择集群主机所在厂商、区域。
- 输入以下数据库基本信息:
- 数据库类型
- CPU 体系架构
- 数据库版本
- 参数组
- 设置数据库产品各组件的以下配置:
- 所在可用区
- 实例规格
- 实例数量
- 输入集群的以下基本信息:
- 集群名称 。集群名称必须是 4 - 64 个字符,可包含大小写字母、数字和连字符,并以字母或数字开头。
- 集群标签
- 数据库管理员 Root 的密码。密码必须是 8-64 个字符,可包含大小写字母、数字和可见的特殊字符(包括
!@#$%^&*()_+=)
) - 是否独占部署
- 点击提交按钮,确认主机资源库存满足集群要求后,点击确认创建按钮。
删除集群
由于业务或其他原因,如果你不再需要某个已创建的实例,可以将此集群删除。
前置条件
- 已登录 TiUniManager 控制台。
- 待删除的 TiDB 集群已存在。
删除集群同时将删除集群上自动备份的数据。如果需要某个备份数据,应在删除实例之前将该备份恢复到新实例上,数据恢复操作可参见TiUniManager 用户手册 - 备份管理-数据恢复 。
操作步骤
- 进入集群管理 > 集群页面。
- 选择待删除的集群,点击集群 ID 进入集群详情页面。
- 点击删除按钮。
- 选择是否在删除集群前完成一次数据备份。
- 选择是否保留手动备份数据。
- 输入 "delete" 以确认删除,点击确认删除按钮。
接管集群
通过 TiUniManager 接管已经存在的 TiDB 集群,统一管理新老集群,提高集群管理效率。
前置条件
已经登录 TiUniManager 控制台。
操作步骤
- 进入集群管理 > 集群页面。
- 点击接管集群按钮,进入接管集群页面。
- 输入接管集群的基本信息:集群名称、数据库用户名 root、数据库密码。
- 输入接管集群中控配配置信息:
- 接管集群中控机主机 IP 地址
- 接管集群中控机 SSH 端口号
- 接管集群中控机 SSH 用户名
- 接管集群中控机 SSH 密码
- 接管集群中控机 TiUP 路径(即
.tiup
目录所在路径,不含路径结尾的/
,例如/root/.tiup
不能填写为/root/.tiup/
)
- 导入接管集群的主机(导入主机流程参见将主机节点加入 TiDB 集群)。