diff --git a/TOC.md b/TOC.md index a10554c843fd..34ccb831cda8 100644 --- a/TOC.md +++ b/TOC.md @@ -612,23 +612,6 @@ - [不同库名或表名的数据校验](/sync-diff-inspector/route-diff.md) - [分库分表场景下的数据校验](/sync-diff-inspector/shard-diff.md) - [基于 DM 同步场景下的数据校验](/sync-diff-inspector/dm-diff.md) - - TiUniManager - - [概述](/tiunimanager/tiunimanager-overview.md) - - [安装和运维](/tiunimanager/tiunimanager-install-and-maintain.md) - - [快速操作](/tiunimanager/tiunimanager-quick-start.md) - - 操作指南 - - [登录与初始化](/tiunimanager/tiunimanager-login-and-initialize.md) - - [管理集群资源](/tiunimanager/tiunimanager-manage-host-resources.md) - - [管理集群](/tiunimanager/tiunimanager-manage-clusters.md) - - [导入与导出数据](/tiunimanager/tiunimanager-import-and-export-data.md) - - [管理任务](/tiunimanager/tiunimanager-manage-tasks.md) - - [管理系统](/tiunimanager/tiunimanager-manage-system.md) - - [FAQ](/tiunimanager/tiunimanager-faq.md) - - 发布版本历史 - - [发布版本汇总](/tiunimanager/tiunimanager-release-notes.md) - - [v1.0.2](/tiunimanager/tiunimanager-release-1.0.2.md) - - [v1.0.1](/tiunimanager/tiunimanager-release-1.0.1.md) - - [v1.0.0](/tiunimanager/tiunimanager-release-1.0.0.md) - 参考指南 - 架构 - [概述](/tidb-architecture.md) diff --git a/_index.md b/_index.md index df0f0f1dd220..c616e86b0c7c 100644 --- a/_index.md +++ b/_index.md @@ -115,8 +115,6 @@ hide_commit: true [PingCAP Clinic](https://docs.pingcap.com/zh/tidb/dev/clinic-introduction) -[TiUniManager](https://docs.pingcap.com/zh/tidb/dev/tiunimanager-overview) - diff --git a/download-ecosystem-tools.md b/download-ecosystem-tools.md index 57154a7250fc..6e714915be51 100644 --- a/download-ecosystem-tools.md +++ b/download-ecosystem-tools.md @@ -5,7 +5,7 @@ aliases: ['/docs-cn/dev/download-ecosystem-tools/','/docs-cn/dev/reference/tools # TiDB 工具下载 -本文介绍如何下载 TiDB 工具包以及 [TiUniManager](/tiunimanager/tiunimanager-overview.md)。关于 TiDB 工具包的内容，请查看 [TiDB 离线包](/binary-package.md)。 +本文介绍如何下载 TiDB 工具包。关于 TiDB 工具包的内容，请查看 [TiDB 离线包](/binary-package.md)。 ## TiDB 工具包下载 @@ -50,16 +50,3 @@ TiDB 工具包中包含了一些常用的 TiDB 工具，例如数据导出工具 > **注意：** > > 以上离线包名称中，`{version}` 取决于离线包中工具的版本号，`{arch}` 取决于离线包对应的架构（amd64 或 arm64）。 - -## TiUniManager 下载 - -[TiUniManager](/tiunimanager/tiunimanager-overview.md) 是为 TiDB 打造的管控平台软件和数据库运维管理平台。使用下表中的链接下载 TiUniManager： - -| 安装包 | 操作系统 | 架构 | SHA256 校验和 | -|:---|:---|:---|:---| -| `https://download.pingcap.org/em-enterprise-server-{version}-linux-amd64.tar.gz` | Linux | amd64 | `https://download.pingcap.org/em-enterprise-server-{version}-linux-amd64.tar.gz.sha256` | - -> **注意：** -> -> - 下载链接中的 `{version}` 为 TiUniManager 的版本号。例如，`v1.0.2` 版本的下载链接为 `https://download.pingcap.org/em-enterprise-server-v1.0.2-linux-amd64.tar.gz`。 -> - TiUniManager 从 v1.0.2 起开放源代码，因此下载链接中 `{version}` 支持的最低版本为 `v1.0.2`。你不能将 `{version}` 替换为 `v1.0.0` 或 `v1.0.1`。 diff --git a/ecosystem-tool-user-guide.md b/ecosystem-tool-user-guide.md index 34184bbf462c..4932b4cbf48e 100644 --- a/ecosystem-tool-user-guide.md +++ b/ecosystem-tool-user-guide.md @@ -9,7 +9,7 @@ TiDB 提供了丰富的工具，可以帮助你进行部署运维、数据管理 ## 部署运维工具 -TiDB 提供了 TiUP、TiDB Operator 和 TiUniManager 三种部署运维工具，满足你在不同系统环境下的部署运维需求。 +TiDB 提供了 TiUP 和 TiDB Operator 部署运维工具，满足你在不同系统环境下的部署运维需求。 ### 在物理机或虚拟机上部署运维 TiDB @@ -26,18 +26,6 @@ TiDB 提供了 TiUP、TiDB Operator 和 TiUniManager 三种部署运维工具， - [TiUP 组件管理](/tiup/tiup-component-management.md) - 适用 TiDB 版本：v4.0 及以上 -#### TiUniManager - -[TiUniManager](/tiunimanager/tiunimanager-overview.md) 是一款以 TiDB 数据库为核心的数据库管理平台，帮助用户在本地部署环境或公有云环境中管理 TiDB 集群。 - -TiUniManager 不仅提供对 TiDB 集群的全生命周期的可视化管理，也同时一站式提供 TiDB 数据库参数管理、数据库版本升级、克隆集群、主备集群切换、数据导入导出、数据同步、数据备份恢复服务，能有效提高 TiDB 集群运维效率，降低企业运维成本。 - -基本信息： - -- [TiUniManager 使用场景](/tiunimanager/tiunimanager-overview.md#使用场景) -- [TiUniManager 安装和运维指南](/tiunimanager/tiunimanager-install-and-maintain.md) -- [TiUniManager 与 TiUP 的关系](/tiunimanager/tiunimanager-faq.md#tiunimanager-与-tiup-的关系是什么) - ### 在 Kubernetes 上部署运维 TiDB - TiDB Operator [TiDB Operator](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable) 是 Kubernetes 上的 TiDB 集群自动运维系统，提供包括部署、升级、扩缩容、备份恢复、配置变更的 TiDB 全生命周期管理。借助 TiDB Operator，TiDB 可以无缝运行在公有云或自托管的 Kubernetes 集群上。 diff --git a/faq/faq-overview.md b/faq/faq-overview.md index 80b8837febbd..6b21f7110f18 100644 --- a/faq/faq-overview.md +++ b/faq/faq-overview.md @@ -14,8 +14,8 @@ summary: 汇总 TiDB 产品的常见问题解答。 | 数据迁移 | | | 数据备份与恢复 | [备份与恢复常见问题](/faq/backup-and-restore-faq.md) | | SQL 使用 | [SQL 操作常见问题](/faq/sql-faq.md) | -| 集群升级 | [TiDB 集群升级常见问题](/faq/upgrade-faq.md) | -| 集群管理 | | +| 集群升级 | [TiDB 集群升级常见问题](/faq/upgrade-faq.md) | +| 集群管理 | [TiDB 集群管理常见问题](/faq/manage-cluster-faq.md) | | 监控报警 | | | 高可用和高可靠 | | | 常见错误码 | [错误码与故障诊断](/error-codes.md) | diff --git a/faq/manage-cluster-faq.md b/faq/manage-cluster-faq.md index 30d2c42bbda8..c8014a2ae855 100644 --- a/faq/manage-cluster-faq.md +++ b/faq/manage-cluster-faq.md @@ -84,10 +84,6 @@ TiDB 目前社区非常活跃，同时，我们还在不断的优化和修改 BU - 通过 `select tidb_version()` 进行查看 - 通过执行 `tidb-server -V` 进行查看 -### 有没有图形化部署 TiDB 的工具？ - -有。你可以使用 [TiUniManager](/tiunimanager/tiunimanager-overview.md)，它是一款为分布式数据库 TiDB 打造的管控平台软件和数据库运维管理平台，为 TiDB 提供数据库集群管理功能、主机管理功能和平台管理功能，涵盖了数据库运维人员 (DBA) 在 TiDB 上进行的常用运维操作，帮助 DBA 对 TiDB 进行自动化、自助化和可视化管理。 - ### 如何扩容 TiDB 集群？ 可以在不影响线上服务的情况下，对 TiDB 集群进行扩容。 diff --git a/tiunimanager/tiunimanager-faq.md b/tiunimanager/tiunimanager-faq.md deleted file mode 100644 index eadb791c5e5f..000000000000 --- a/tiunimanager/tiunimanager-faq.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -title: TiUniManager 常见问题 -summary: 了解 TiUniManager 的常见问题以及回答。 ---- - -# TiUniManager 常见问题 - -本文档介绍 TiUniManager 的常见问题，帮助用户更好了解 TiUniManager。 - -## 产品基本 FAQ - -### TiUniManager 管理的集群可以部署在哪里？ - -TiUniManager 管理的集群可以部署在用户自建的数据中心或公有云。 - -### TiUniManager 面向哪几类用户？ - -TiUniManager 面向三类用户：IT 系统管理员、数据库管理员 DBA、数据库应用开发人员。 - -### TiUniManager 支持的 TiDB 版本有哪些？ - -见 [TiUniManager 支持的 TiDB 版本](/tiunimanager/tiunimanager-release-notes.md#tiunimanager-支持的-tidb-版本)。 - -### TiUniManager 与 TiUP 的关系是什么？ - -TiUniManager 使用 TiDB 及其生态工具、API 提供数据库管理产品功能，TiUP 是 TiUniManager 使用的工具之一。TiUniManager 产品架构图如下： - -![TiUniManager 架构图](/media/tiunimanager/tiunimanager-architecture.png) - -## 主机资源管理 FAQ - -### 何时导入主机资源到 TiUniManager？ - -在创建新集群或导入现有集群前，你需要将集群所需的主机资源导入到 TiUniManager。具体步骤参见 [TiUniManager 资源管理](/tiunimanager/tiunimanager-manage-host-resources.md)。 - -## TiUniManager 安装部署 FAQ - -### TiUniManager 支持离线安装吗？ - -支持 - -### TiUniManager 首次部署后，需要如何做产品初始化吗？ - -TiUniManager 首次部署后，需要对 TiDB 组件规格、数据中心 Zone 信息、主机规格信息进行初始化。 - -### 如何在命令行查看 EM 服务和 EM 部署的 TiDB 集群信息？ - -首先请先通过 `su - tidb` 命令切换到 `tidb` 账号下。 - -所有与 EM 工具相关的命令，请以 `TIUP_HOME=/home/tidb/.em tiup em ` 的方式执行，例如 `TIUP_HOME=/home/tidb/.em tiup em list`。 - -所有与 EM 部署的 TiDB 集群相关的命令，请以直接以 `tiup cluster ` 的方式执行，例如 `tiup cluster list`。 - -## 集群部署 FAQ - -### TiUniManager 支持在离线环境中部署 TiDB 集群吗？ - -支持 - -### TiKV 实例数与 TiKV 的关系？ - -创建集群时，TiKV 副本数建议为 1 个、3 个、5 个、或 7 个。设置的 TiKV 实例数不能小于 TiKV 副本数。 - -### 建议的 PD 实例数量？ - -建议的 PD 实例数量为 1 个、3 个、5 个、或 7 个。 - -## 备份与恢复 FAQ - -### 备份支持的存储类型有哪些？ - -TiUniManager 支持将数据备份至 S3 兼容存储和 NFS 共享存储。 - -### 如何设置 TiUniManager 的备份路径？ - -TiUniManager 目前不支持通过前端界面修改备份路径，修改备份路径方法参考 [TiUniManager 备份管理](/tiunimanager/tiunimanager-manage-clusters.md#备份管理---数据备份)。 - -## 数据导入与导出 FAQ - -### 可以从哪些上游导入数据到 TiUniManager？ - -你可以从 S3 兼容存储、本地存储、或 TiUniManager 共享存储上导入集群。 - -### 导出的数据可以保存在哪些存储上？ - -导出的数据可以保存至 S3 兼容存储或 TiUniManager 共享存储，对于保存在 TiUniManager 共享存储上的导入数据，你可进一步下载至本地。 - -### 从本地上传的导入文件大小有限制吗？ - -从本地上传的源数据文件大小不能超过 2 GB。 - -### 什么是 TiUniManager 共享存储？ - -TiUniManager 共享存储是用户事先设定好用于保存导入导出文件的文件资源池，该文件资源池是一个可挂载于 TiUniManager 中控机的 NFS 目录，该 NFS 路径由用户在 TiUniManager 安装后进行设置。 - -### 如何修改 TiUniManager 共享存储路径？ - -参见 [TiUniManager 数据导入与导出](/tiunimanager/tiunimanager-import-and-export-data.md)。 - -## 集群扩容缩容 FAQ - -### 对组件实例进行缩容时有何限制？ - -TiDB、PD、TiKV 的实例数量最小为 1。当实例数等于 1 时，不能进行缩容操作。 - -### TiKV 实例数与 TiKV 副本数有何关系？ - -TiKV 实例数量不能低于 TiKV 副本数。对 TiKV 进行缩容时，缩容后的 TiKV 实例数量不能小于 TiKV 副本数。 - -## 接管集群 FAQ - -### TiUniManager 接管集群前有什么注意事项吗？ - -建议用户在 TiUniManager 接管集群前，对集群进行一次数据备份。 - -### 接管集群时需要用户填写的“TiUP 部署路径”是什么？ - -“TiUP 部署路径”是被接管集群中 TiUP 的 home 路径。填写该路径时，请勿填写路径结尾的 `/`。 - -例如，请勿填写为 `/root/.tiup/`。 diff --git a/tiunimanager/tiunimanager-import-and-export-data.md b/tiunimanager/tiunimanager-import-and-export-data.md deleted file mode 100644 index f93d5fe2676a..000000000000 --- a/tiunimanager/tiunimanager-import-and-export-data.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -title: TiUniManager 数据导入与导出 -summary: 了解如何使用 TiUniManager 从 TiDB 集群导入和导出数据。 ---- - -# TiUniManager 数据导入与导出 - -本文档介绍如何使用 TiUniManager 从 TiDB 集群导入和导出数据。 - -## 导入数据 - -DBA 管理员可从 S3 兼容存储、本地存储、或 TiUniManager 共享存储上，导入 SQL 文件、CSV 文件的数据到 TiDB 集群。 - -TiUniManager 共享存储是用户事先设定好、用于保存导入导出文件的文件资源池，该文件资源池是一个可挂载于 TiUniManager 中控机的 NFS 目录，你可在安装 TiUniManager 后设置该路径。 - -### 导入前准备 - -进行操作前，确保已经登录 TiUniManager 控制台。 - -> **注意：** -> -> - 从本地上传的源数据文件大小不能超过 2 GiB -> - TiUniManager 最多支持 3 个导入导出任务并行运行，后续任务在队列中等待 - -TiUniManager 默认的导入导出路径是在 TiUniManager 中控机上，细节如下： - -| **配置描述** | **配置参数名** | **参考值** | -| ------------------------------------------------------------ | ---------------------- | ------------------------------------------------------------ | -| TiUniManager 共享存储中导入文件的存储位置（建议配置为 NFS 共享存储） | `ImportShareStoragePath` | `/home/tidb/import`（备注：中控机 `tidb` 账号拥有该路径的读写权限) | -| TiUniManager 共享存储中导出文件的存储位置（建议配置为 NFS 共享存储） | `ExportShareStoragePath` | `/home/tidb/export`（备注：中控机 `tidb` 账号拥有该路径的读写权限） | - -当前 TiUniManager 不支持通过前端界面修改导入路径。如需修导入路径，需要通过 OpenAPI 对配置进行修改，以修改 `ImportShareStoragePath` 为例： - -1. 登录获取 user token。 - - {{< copyable "shell-regular" >}} - - ```shell - 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 服务端口。 - -2. 查看配置参数值。 - - {{< copyable "shell-regular" >}} - - ```shell - curl -X GET "http://172.16.6.206:4100/api/v1/config/?configKey=ImportShareStoragePath" -H "Authorization: Bearer 6ea768e4-c0ec-4d48-b401-0f114ddc994c" - ``` - -3. 修改配置参数值为 `newValue`（根据实际的环境设置为新的存储路径）。 - - {{< copyable "shell-regular" >}} - - ```shell - curl -X POST "http://172.16.6.206:4100/api/v1/config/update" -d "{ \"configKey\": \"ImportShareStoragePath\", \"configValue\": \"newValue\"}" -H "Authorization: Bearer 6ea768e4-c0ec-4d48-b401-0f114ddc994c" - ``` - -### 导入数据操作步骤 - -1. 进入**集群管理** > **导入导出**页面。 -2. 点击**导入数据**按钮，进入导入页面。 -3. 输入目标集群信息：集群 ID、数据库用户名、数据库密码。 -4. 选择源数据。存储位置可以是本地文件或 TiUniManager 共享存储或 S3 兼容存储。 -5. 输入本次导入备注信息。 -6. 点击**创建导入任务**开始导入。 - -## 导出数据 - -DBA 管理员可从 TiDB 集群将数据以 SQL 文件或 CSV 文件格式，导出至 S3 兼容存储、本地存储或 TiUniManager 共享存储，并可对导出数据进行筛选。数据筛选的方式包括： - -* 按 SQL 语句对导出数据进行筛选 -* 按指定库表对导出数据进行筛选 - -对于保存在 TiUniManager 共享存储上的导入数据，你可进一步下载至本地。 - -### 导出前准备 - -在导出数据前，确保已经登录 TiUniManager 控制台。 - -> **注意：** -> -> * TiUniManager 最多支持 3 个导入导出任务并行运行，后续任务在队列中等待。 -> * 从 TiUniManager 共享存储下载的导出数据文件大小不能超过 2 GiB。 - -当前 TiUniManager 前端不支持修改导入导出路径，如需修改导入导出路径，需要通过 OpenAPI 对配置进行修改，以修改 `ExportShareStoragePath` 为例： - -1. 登录获取 user token。 - - {{< copyable "shell-regular" >}} - - ```shell - 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 服务端口。 - -2. 查看配置参数值。 - - {{< copyable "shell-regular" >}} - - ```shell - curl -X GET "http://172.16.6.206:4100/api/v1/config/?configKey=ExportShareStoragePath" -H "Authorization: Bearer 6ea768e4-c0ec-4d48-b401-0f114ddc994c" - ``` - -3. 修改配置参数值为 `newValue`（根据实际环境设置为新的存储路径）。 - - {{< copyable "shell-regular" >}} - - ```shell - curl -X POST "http://172.16.6.206:4100/api/v1/config/update" -d "{ \"configKey\": \"ExportShareStoragePath\", \"configValue\": \"newValue\"}" -H "Authorization: Bearer 6ea768e4-c0ec-4d48-b401-0f114ddc994c" - ``` - -### 导出数据操作步骤 - -1. 进入**集群管理** > **导入导出**页面。 -2. 点击**导出数据**按钮，进入导出数据页面。 -3. 输入源集群信息：集群 ID、数据库用户名、数据库密码。 -4. 选择导出目标位置：TiUniManager 共享存储或 S3 兼容存储。 -5. 设置导出选项：导出文件格式，是否筛选数据及筛选条件。 -6. 记录本次导出备注信息。 -7. 点击**创建导出任务**开始导出数据。 - -## 查看数据的导入导出记录 - -你可以通过 TiUniManager 查看、删除数据的导入导出记录，并下载记录文件至本地。 - -在查看数据的导入导出记录前，确保已经登录 TiUniManager 控制台。 - -查看数据的导入导出记录的操作步骤如下： - -1. 进入**集群管理** > **导入导出**页面。 -2. 查看导入导出记录列表。 -3. 选择导出记录的**下载**，可下载导出记录至本地。 -4. 选择记录的**删除**，可删除导入导出记录。 diff --git a/tiunimanager/tiunimanager-install-and-maintain.md b/tiunimanager/tiunimanager-install-and-maintain.md deleted file mode 100644 index 9d72c697b314..000000000000 --- a/tiunimanager/tiunimanager-install-and-maintain.md +++ /dev/null @@ -1,630 +0,0 @@ ---- -title: TiUniManager 安装和运维指南 -summary: 了解 TiUniManager 安装部署流程，指导数据库管理员完成 TiUniManager 的部署和配置。 ---- - -# TiUniManager 安装和运维指南 - -本文档介绍 TiUniManager 的安装部署流程以及运维方法，指导数据库管理员完成 TiUniManager 的部署和配置。 - -## 软硬件环境配置 - -本节介绍部署 TiUniManager 前需要满足的软硬件环境配置要求。 - -### Linux 操作系统版本 - -要部署和运行 TiUniManager 服务，确保 Linux 操作系统的版本满足以下要求： - -| Linux 操作系统 | 版本 | -| :--- | :--- | -| Red Hat Enterprise Linux | 7.3 及以上的 7.x 版本 | -| CentOS | 7.3 及以上的 7.x 版本 | - -### 中控机软件配置 - -TiUniManager 中控机是运行 TiUniManager 服务的中央控制节点。你可通过登录 TiUniManager 中控机上的 Web console 或 OpenAPI 完成对 TiDB 集群的日常管理。中控机的软件配置要求如下： - -| 软件 | 版本 | -| :--- | :--- | -| sshpass | 1.06 及以上 -| TiUP | 1.9.0 及以上 | - -### 服务器配置 - -TiUniManager 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器平台上。对于开发、测试、及生产环境的服务器硬件配置（不包含操作系统 OS 本身的占用）有以下要求： - -#### 开发及测试环境 - -在开发及测试环境中，对服务器硬件配置要求如下： - -| 组件 | CPU | 内存 | 硬盘类型 | 网络 | 实例数量（最低要求） | -| ---- | ----- | ------ | -------- | -------------------- | -------------------- | -| TiUniManager | 8 核+ | 16 GB+ | SAS | 万兆网卡（2 块最佳） | 1 | - -#### 生产环境 - -在生产环境中，对服务器硬件配置要求如下： - -| 组件 | CPU | 内存 | 硬盘类型 | 网络 | 实例数量（最低要求） | -| ---- | ------ | ------- | -------- | -------------------- | -------------------- | -| TiUniManager | 48 核+ | 128 GB+ | SAS/SSD | 万兆网卡（2 块最佳） | 1 | - -### 网络要求 - -TiUniManager 正常运行需要网络环境提供如下端口配置，管理员可根据实际环境中 TiUniManager 组件部署的方案，在网络侧和主机侧开放相关端口： - -| 组件 | 默认端口 | 说明 | -| ---------- | ------------ | -------------------------------------- | -| Web server | 4180 或 4183 | HTTP 端口：4180
HTTPS 端口：4183 | -| OpenAPI server| 4100 或 4103 | OpenAPI 服务端口: 4100
OpenAPI 监控端口：4103 | -| Cluster server | 4101 或 4104 | 集群服务端口 | -| File server | 4102 或 4105 | 文件上传或下载的服务器端口 | -| etcd | 4106 或 4107 | etcd 服务端口 | -| Elasticsearch server | 4108 | Elasticsearch 服务端口 | -| Kibana server | 4109 | Kibana 服务端口 | -| Prometheus | 4110 | Prometheus 服务端口 | -| Grafana server | 4111 | Grafana 服务端口 | -| Alertmanager server | 4112 或 4113 | 告警管理服务端口 | -| Jaeger(tracer server ) | 4114 到 4123 | Jaeger 服务端口 | -| node_exporter | 4124 | TiUniManager 主机系统上报信息的通信端口 | - -## 客户端 Web 浏览器要求 - -你可在较新版本的常见桌面浏览器中使用 TiUniManager，浏览器的版本要求如下： - -- Chrome \> 79 -- Firefox \> 72 -- Microsoft Edge \> 79 -- Safari \> 14 - -> **注意：** -> -> 若使用旧版本浏览器或其他浏览器访问 TiUniManager，部分界面可能无法正常工作。 - -## 拓扑模板 - -在线部署 TiUniManager 前，你需要准备好 YAML 拓扑文件。TiUniManager 离线包中包含 YAML 拓扑文件模板。本节介绍用于部署 TiUniManager 拓扑配置模版。 - -
-TiUniManager 拓扑配置模版 config.yaml（单机版） - -```yaml -global: - user: "tidb" - group: "tidb" - ssh_port: 22 - deploy_dir: "/em-deploy" - data_dir: "/em-data" - arch: "amd64" - log_level: "info" - # specify the external elasticsearch address. default is empty - # and elasticsearch_servers can only have one value - external_elasticsearch_url: "" - login_host_user: "" - login_private_key_path: "" - login_public_key_path: "" - -monitored: - node_exporter_port: 4124 - -em_cluster_servers: - - host: {ip} - # port: 4101 - # metrics_port: 4104 - # registry_client_port: 4106 - # registry_peer_port: 4107 - # deploy_dir: "/em-deploy/cluster-server-4101" - # data_dir: "/em-data/cluster-server-41101" - -em_api_servers: - - host: {ip} - # port: 4100 - # metrics_port: 4103 - # deploy_dir: "/em-deploy/openapi-server-4100" - # data_dir: "/em-data/openapi-server-4100" - -em_web_servers: - - host: {ip} - # port: 4180 - # deploy_dir: "/em-deploy/em-web-4180" - # data_dir: "/em-data/em-web-4180" - -em_file_servers: - - host: {ip} - # port: 4102 - # metrics_port: 4105 - # deploy_dir: "/em-deploy/file-server-4102" - # data_dir: "/em-data/file-server-4102" - -elasticsearch_servers: - - host: {ip} - # port: 4108 - # heap_size: "4g" - # deploy_dir: "/em-deploy/elasticsearch-4108" - # data_dir: "/em-data/elasticsearch-4108" - -tracer_servers: - - host: {ip} - # port: 4114 - # web_port: 4115 - # zipkin_thrift_port: 4116 - # compact_thrift_port: 4117 - # binary_thrift_port: 4118 - # agent_serve_port: 4119 - # jaeger_thrift_port: 4120 - # jaeger_host_port: 4121 - # collector_port: 4122 - # grpc_serve_port: 4123 - # deploy_dir: "/em-deploy/tracer-4114" - # data_dir: "/em-data/tracer-4114" - -kibana_servers: - - host: {ip} - # port: 4109 - # deploy_dir: "/em-deploy/kibana-4109" - # data_dir: "/em-data/kibana-4109" - -monitoring_servers: - - host: {ip} - # port: 4110 - # deploy_dir: "/em-deploy/prometheus-4110" - # data_dir: "/em-data/prometheus-4110" - -alertmanager_servers: - - host: {ip} - # web_port: 4112 - # cluster_port: 4113 - # deploy_dir: "/em-deploy/alertmanager-4112" - # data_dir: "/em-data/alertmanager-4112" - -grafana_servers: - - host: {ip} - # port: 4111 - # deploy_dir: "/em-deploy/grafana-4111" - # data_dir: "/em-data/grafana-4111" - -filebeat_servers: - - host: {ip} - # deploy_dir: "/em-deploy/filebeat-0" - # data_dir: "/em-data/filebeat-0" -``` - -
- -如果 TiUniManager 中控机通过用户名密钥访问 TiDB 资源机，需要参照指定 TiUniManager 中控机登录 TiDB 资源机的用户名和密钥，在配置文件 `config.yaml` 中指定用户名和密钥。 - -## 离线部署 TiUniManager - -本节介绍如何在离线环境部署 TiUniManager。当前 TiUniManager 只支持通过离线部署。 - -1. 通过 `https://download.pingcap.org/em-enterprise-server-${version}-linux-amd64.tar.gz` 下载 TiUniManager 离线安装包。 - - 下载链接中的 `${version}` 为 TiUniManager 的版本号。例如，`v1.0.2` 版本的下载链接为 `https://download.pingcap.org/em-enterprise-server-v1.0.2-linux-amd64.tar.gz`。在下载时，你需要将链接中的 `${version}` 替换为目标版本号。 - -2. 发送 TiUniManager 离线安装包至 TiUniManager 中控机。 - - 离线安装包放置于 TiUniManager 中控机，使用具有 sudo 权限的账号执行后续操作。 - -3. 解压 TiUniManager 离线包。 - - {{< copyable "shell-regular" >}} - - ```shell - tar xzvf em-enterprise-server-${version}-linux-amd64.tar.gz - ``` - -4. 安装 TiUniManager。进入解压后的目录，执行 `install.sh` 脚本。 - - {{< copyable "shell-regular" >}} - - ```shell - sudo sh em-enterprise-server-${version}-linux-amd64/install.sh - ``` - -5. 声明环境变量。 - - ```shell - # 切换到 tidb 账号下 - su - tidb - - # 声明环境变量，使 tiup 工具生效 - source /home/tidb/.bash_profile - ``` - -6. 生成 tidb 帐户下的密钥。 - - ```shell - # 切换到 tidb 账号下 - su - tidb - - # 生成 rsa 密钥 - ssh-keygen -t rsa - - # 复制密钥到 tiup_rsa - cp /home/tidb/.ssh/id_rsa /home/tidb/.ssh/tiup_rsa - ``` - -7. 编辑拓扑配置文件。根据实际环境，你可编辑位于 `/home/tidb/` 下的拓扑配置文件 `config.yaml`。 - -8. 导入 TiDB Server 离线镜像包。 - - 离线环境下，需要在 TiUniManager 中控机本地目录上导入 TiDB 离线镜像包，否则无法通过 TiUniManager 中控机完成对 TiDB 集群的日常管理。 - - ```shell - # 切换到 tidb 账号下 - su - tidb - - # 下载解压 TiDB Server 离线镜像包，将 ${version} 手动替换为实际的 TiDB 版本号。 - - wget https://download.pingcap.org/tidb-community-server-${version}-linux-amd64.tar.gz - tar xzvf tidb-community-server-${version}-linux-amd64.tar.gz - - # 导入离线镜像包 - TIUP_HOME=/home/tidb/.tiup tiup mirror merge tidb-community-server-${version}-linux-amd64 - ``` - - 在 TiUniManager 中控机上查看本地 TiDB 镜像源。 - - ```shell - # 切换到 tidb 账号下 - su - tidb - - # 查看 TiDB 镜像源地址 - tiup mirror show - ``` - -9. 执行命令部署 TiUniManager。 - - ```shell - # 切换到 tidb 账号下 - su - tidb - - # 部署名称为 "em-test" 的 TiUniManager，注意这里的版本号不带 v，比如 v1.0.0 的版本号，正确的输入是 1.0.0 - TIUP_HOME=/home/tidb/.em tiup em deploy em-test <版本号> config.yaml -u <具有sudo权限的账号> -p - - # 启动 TiUniManager - TIUP_HOME=/home/tidb/.em tiup em start em-test - ``` - -## 指定 TiUniManager 中控机登录 TiDB 资源机的帐户和密钥 - -默认情况下，你可以通过 TiUniManager Web 控制台**资源管理** > **导入主机**页面提供的主机资源模板填写 TiDB 资源机帐户和密码。 - -如果用户环境中不允许账号密码方式登录 TiDB 资源机，可在 `config.yaml` 文件中进行配置，以帐户密钥方式登录 TiDB 资源机。`config.yaml` 中相关配置项如下： - -| 配置描述 | 配置参数名 | 示例值 | -| --- | --- | --- | -| login-host-user | 登录 TiDB 资源机的用户名 | tidb | -| login-private-key-path | 位于 TiUniManager 中控机上登录 TiDB 资源机使用的私钥路径 | /home/tidb/.ssh/id_rsa | -| login-public-key-path | 位于 TiUniManager 中控机登录 TiDB 资源机使用的公钥路径 | /home/tidb/.ssh/id_rsa.pub | - -## 升级 TiUniManager（适用于 v1.0.1 及以上版本） - -本节适用于安装过 TiUniManager v1.0.1 及以上版本，并打算升级 TiUniManager 的用户。如首次安装可跳过本节。 - -> **注意：** -> -> - 本节介绍的方法仅适用于从 TiUniManager v1.0.1 升级至 v1.0.2 及以上版本，不适用于从 v1.0.0 升级至 v1.0.1 及以上版本。 -> - 如果你已安装 TiUniManager v1.0.0 版本，想要升级至 v1.0.1 及以上版本，则需要先参考[升级 TiUniManager v1.0.0 至 v1.0.1](#升级-tiunimanager-v100-至-v101) 进行升级，再参考本节内容从 v1.0.1 升级至较新的目标版本。 -> - 在 v1.0.0 和 v1.0.1 中，TiUniManager 原名为 TiDB Enterprise Manager。自 v1.0.2 起正式更名为 TiUniManager。 - -1. 升级 TiUniManager 离线包。 - - 参考[离线部署 TiUniManager](#离线部署-tiunimanager) 中第 1-3 步：通过 TiUniManager 产品团队获得最新 TiUniManager 离线包，发送 TiUniManager 离线安装包至目标集群的 TiUniManager 中控机，解压离线包。然后执行下面命令更新 TiUniManager 离线包。 - - {{< copyable "shell-regular" >}} - - ```shell - # user 为之前部署 TiUniManager 的帐户，默认为 tidb。${version} 为 TiUniManager 的版本号，需要手动替换为实际的版本号。 - sudo sh em-enterprise-server-${version}-linux-amd64/update.sh - ``` - -2. 执行升级 TiUniManager 命令。 - - {{< copyable "shell-regular" >}} - - ```shell - # 切换到 tidb 账号下 - su - tidb - - # 将集群 升级到特定版本 - # 目前仅支持原地停机升级，并且暂不支持版本降级和回退。为安全起见，请按照 停止集群 > 备份 tiunimanager 元数据 > 升级集群的流程操作 - TIUP_HOME=/home/tidb/.em tiup em upgrade - ``` - -## 升级 TiUniManager v1.0.0 至 v1.0.1 - -本节介绍的方法适用于从 v1.0.0 升级至 v1.0.1。如需升级至更高版本，请先升级至 v1.0.1，再参考[升级 TiUniManager（适用于 v1.0.1 及以上版本）](#升级-tiunimanager适用于-v101-及以上版本)进行升级。如首次安装可跳过本节。 - -> **注意：** -> -> 在 v1.0.0 和 v1.0.1 中，TiUniManager 原名为 TiDB Enterprise Manager。自 v1.0.2 起正式更名为 TiUniManager。 - -1. 升级 TiUniManager 离线包。 - - 参考[离线部署 TiUniManager](#离线部署-tiunimanager) 中第 1-3 步：通过 TiUniManager 产品团队获得最新 TiUniManager 离线包，发送 TiUniManager 离线安装包至目标集群的 TiUniManager 中控机，解压离线包。然后执行下面命令更新 TiUniManager 离线包。 - - {{< copyable "shell-regular" >}} - - ```shell - # user 为之前部署 TiUniManager 的帐户，默认为 tidb - sudo sh em-enterprise-server-v1.0.1-linux-amd64/update.sh - ``` - -2. 做升级 TiUniManager 之前的准备。 - - 执行以下命令为 TiUniManager 升级做准备。以下命令会自动备份 TiUniManager v1.0.0 中的数据。请注意，执行完此命令后直至升级完成，请不要再通过 TiUniManager 界面做其它操作，以避免备份未包含最新数据导致升级后数据丢失的情况。 - - {{< copyable "shell-regular" >}} - - ```shell - # user 为之前部署 TiUniManager v1.0.0 的帐户，默认为 tidb - # cluster-name 为当前部署的 TiUniManager 名称，默认为 em-test - sudo sh em-enterprise-server-v1.0.1-linux-amd64/prepare_upgrade.sh - ``` - -3. 检查新的 TiUniManager 部署拓扑文件。 - - 如果你在部署 TiUniManager v1.0.0 时曾对 `config.yaml` 文件做了自定义修改，请参考下列子步骤查看 v1.0.0 的配置文件 `config.yaml` 和待部署 v1.0.1 配置文件 `config-v1.0.1.yaml` 的区别，并做相应修改。 - - 1. 切换至 `tidb` 账号。 - - {{< copyable "shell-regular" >}} - - ```shell - su - tidb - ``` - - 2. 查看配置变更。 - - 对比 `config.yaml` 和 `config-v1.0.1.yaml` 生效内容的差异。如果差异仅为 `db_path` 所在行，则可跳过本步骤，无须执行后续子步骤（备份 `db_path` 以及更新 `config-v1.0.1.yaml`），可直接进入删除 TiUniManager v1.0.0 的步骤。如果差异不仅有 `db_path` 所在行，还存在其它差异，则需要继续执行后续子步骤（备份 `db_path` 以及更新 `config-v1.0.1.yaml`）。 - - {{< copyable "shell-regular" >}} - - ```shell - diff config.yaml config-v1.0.1.yaml - ``` - - 3. 记下 `config-v1.0.1.yaml` 中的数据备份路径 `db_path`。 - - `db_path` 为 TiUniManager 备份数据的路径。在“升级 TiUniManager 之前的准备”这一步中 TiUniManager 已经自动在 `config-v1.0.1.yaml` 中写好了默认的 v1.0.1 数据备份路径，此前已备份的 v1.0.0 数据将恢复到该路径下。 - - 查看 `config-v1.0.1.yaml` 中的 `db_path`，记下该行内容，在以下子步骤 5 中更新 `config-v1.0.1.yaml` 时需要用到该行内容。示例如下： - - ```yaml - db_path: "/home/tidb/em-backup-20220511-154415/em.db" - ``` - - 4. 覆盖 `config-v1.0.1.yaml`。 - - 将 TiUniManager v1.0.0 的 `config.yaml` 文件复制一份并覆盖 v1.0.1 的 `config-v1.0.1.yaml`。 - - ```shell - cp config.yaml config-v1.0.1.yaml - ``` - - 5. 更新 `config-v1.0.1.yaml`。 - - 覆盖配置文件后，将子步骤 3 中拷贝的 `db_path` 填写至 `config-v1.0.1.yaml`，注意空格的缩进。示例如下： - - ```yaml - em_cluster_servers: - - host: 127.0.0.1 - db_path: "/home/tidb/em-backup-20220511-154415/em.db" - ``` - -4. 删除 TiUniManager v1.0.0。 - - {{< copyable "shell-regular" >}} - - ```shell - # 切换到 tidb 账号下 - su - tidb - - # 查看现有 TiUniManager 服务 - TIUP_HOME=/home/tidb/.em tiup em list - - # 删除指定的 TiUniManager 服务 - TIUP_HOME=/home/tidb/.em tiup em destroy - ``` - -5. 部署 TiUniManager v1.0.1。 - - {{< copyable "shell-regular" >}} - - ```shell - # 切换到 tidb 账号下 - su - tidb - - # 更新 em 工具 - TIUP_HOME=/home/tidb/.em tiup update em - TIUP_HOME=/home/tidb/.em tiup update --all - - # 部署名称为 "em-test" 的 TiUniManager - TIUP_HOME=/home/tidb/.em tiup em deploy em-test 1.0.1 config-v1.0.1.yaml -u <具有sudo权限的账号> -p - - # 启动 TiUniManager - TIUP_HOME=/home/tidb/.em tiup em start em-test - - # 将 db_path 注释掉。如果不注释，后续对 em 进行重启、扩容等操作时 TiUniManager 可能会将数据变更还原 - sed -i "s/ db_path:/# db_path:/" /home/tidb/.em/storage/em/clusters/em-test/meta.yaml - ``` - -6. 重建资源机器的 filebeat。 - - {{< copyable "shell-regular" >}} - - ```shell - # 切换到 tidb 账号下 - su - tidb - - # 重建资源机器 filebeat - TIUP_HOME=/home/tidb/.em tiup em scale-out em-test /home/tidb/em-v1.0.0-backup/resource-filebeat-scale-out-topology.yaml --user tidb -i /home/tidb/.ssh/tiup_rsa --wait-timeout 360 --yes - ``` - -7. 使集群日志功能生效。 - - 待所有上述步骤完成后，大部分的升级已完成。由于在升级过程中，TiUniManager 对资源机器的 filebeat 进行了重装。为了使得查看 TiDB 集群日志功能在 TiUniManager 中生效，你需要手动在 TiUniManager 界面操作重启 TiDB 集群以刷新配置。为避免影响用户服务，请尽量在业务低峰期操作。 - -## 备份恢复 TiUniManager 元信息 - -为提高 TiUniManager 可用性，应对容灾场景，你可对 TiUniManager 元信息进行备份，并恢复元信息到新的 TiUniManager 中控机。 - -1. 备份 TiUniManager 元信息。 - - {{< copyable "shell-regular" >}} - - ```shell - # 切换到 tidb 账号下 - su - tidb - - # 将当前 TiUniManager 系统 的元数据备份到中控机的 - TIUP_HOME=/home/tidb/.em tiup em backup -N - ``` - -2. 恢复 TiUniManager 元信息。 - - {{< copyable "shell-regular" >}} - - ```shell - # 切换到 tidb 账号下 - su - tidb - - db_path: "/home/tidb/em.db" - ``` - - 从备份的元数据中恢复到新集群，流程和部署新集群相同。唯一的区别是在集群 yaml 配置中，`em_cluster_servers` 里增加了 `db_path: "/home/tidb/em.db"`，详细见 [TiUniManager 根据元数据恢复新集群拓扑配置模版 em.yaml（单机版）](#拓扑模板)。 - -## 修改默认的集群备份路径 - -TiUniManager 默认的集群备份路径相关配置参数如下： - -| 配置描述 | 配置参数名 | 参考值 | -| --- | --- | --- | -| TiDB 集群备份的存储类型（仅支持 NFS 或 S3） | BackupStorageType | 's3' 或 'nfs' | -| TiDB 集群备份的存储路径（S3 bucket 路径，或 NFS share 的绝对路径） | BackupStoragePath | 'bucketPath/backup' (S3 路径示例）
'/mnt/nfspath'（NFS 路径示例）| -| TiDB 集群备份在 S3 共享存储时，S3 的 AccessKey | BackupS3AccessKey | '' | -| TiDB 集群备份在 S3 共享存储时，S3 的 SecretAccessKey | BackupS3SecretAccessKey | '' | -| TiDB 集群备份在 S3 共享存储时，S3 的 Endpoint（域名） | BackupS3Endpoint | '' | - -当前不支持通过 TiUniManager 界面修改备份路径。如需修改备份路径，需要通过 OpenAPI 修改配置参数，以修改配置参数 "BackupS3AccessKey" 为例： - -1. 登录获取 user token。 - - {{< copyable "shell-regular" >}} - - ```shell - 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 服务端口。 - -2. 查看配置参数值。 - - {{< copyable "shell-regular" >}} - - ```shell - curl -X GET "http://172.16.6.206:4100/api/v1/config/?configKey=BackupS3AccessKey" -H "Authorization: Bearer 6ea768e4-c0ec-4d48-b401-0f114ddc994c" - ``` - -3. 修改配置参数值 `BackupS3AccessKey` 的值为 `newValue`。你可以将 `newValue` 替换为你期待的备份路径。 - - {{< copyable "shell-regular" >}} - - ```shell - curl -X POST "http://172.16.6.206:4100/api/v1/config/update" -d "{ \"configKey\": \"BackupS3AccessKey\", \"configValue\": \"newValue\"}" -H "Authorization: Bearer 6ea768e4-c0ec-4d48-b401-0f114ddc994c" - ``` - -## 修改默认的数据导入导出路径 - -TiUniManager 默认的导入导出路径在 TiUniManager 中控机上，细节如下： - -| 配置描述 | 配置参数名 | 参考值 | -| --- | --- | --- | -| TiUniManager 共享存储中导入文件存储位置（建议配置为 NFS 共享存储） | ImportShareStoragePath | `/home/tidb/import`（备注：中控机 `tidb` 账号拥有该路径的读写权限）| -| TiUniManager 共享存储中导出文件存储的位置（建议配置为 NFS 共享存储） | ExportShareStoragePath | `/home/tidb/export`（备注：中控机 `tidb` 账号拥有该路径的读写权限）| - -当前 TiUniManager 不支持通过 TiUniManager 界面修改导入导出的路径。如需修导入导出路径，需要通过 OpenAPI 对配置进行修改，以修改 “ImportShareStoragePath” 为例： - -1. 登录获取 user token。 - - {{< copyable "shell-regular" >}} - - ```shell - 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 服务端口。 - -2. 查看配置参数值。 - - {{< copyable "shell-regular" >}} - - ```shell - curl -X GET "http://172.16.6.206:4100/api/v1/config/?configKey=ImportShareStoragePath" -H "Authorization: Bearer 6ea768e4-c0ec-4d48-b401-0f114ddc994c" - ``` - -3. 修改配置参数 `ImportShareStoragePath` 的值为 `newValue`，你可以将 `newValue` 替换为你期待的导入导出路径。 - - {{< copyable "shell-regular" >}} - - ```shell - curl -X POST "http://172.16.6.206:4100/api/v1/config/update" -d "{ \"configKey\": \"ImportShareStoragePath\", \"configValue\": \"newValue\"}" -H "Authorization: Bearer 6ea768e4-c0ec-4d48-b401-0f114ddc994c" - ``` - -## 删除 TiUniManager - -如要删除 TiUniManager 服务，请执行以下命令： - -```shell -su - tidb - -# 查看现有 TiUniManager 服务 -TIUP_HOME=/home/tidb/.em tiup em list - -# 删除指定的 TiUniManager 服务 -TIUP_HOME=/home/tidb/.em tiup em destroy -``` - -## 指定外部的 Elasticsearch 服务 - -Elasticsearch 是一个分布式、高扩展、高实时的搜索与数据分析引擎。它能很方便的使大量数据具有搜索、分析和探索的能力。目前 TiUniManager 主要依赖 Elasticsearch 来做日志数据的存储和检索。 - -TiUniManager 可以通过 `config.yaml` 文件中全局的 `external_elasticsearch_url` 参数来指定外部的 Elasticsearch 服务。默认值为空。 - -`external_elasticsearch_url` 参数值格式为 ``，例如：`127.0.0.1:9200`。 - -在 `config.yaml` 文件中，`external_elasticsearch_url` 和 `elasticsearch_servers` 都是用来指定 Elasticsearch 部署信息的，不能同时指定。如果指定了 `external_elasticsearch_url` 的值，则需要注释掉 `elasticsearch_servers` 组件的配置信息注释。 - -配置格式参考 [TiUniManager 拓扑配置模版 config.yaml（单机版）](#拓扑模板)。 - -## 手动指定部署的 Elasticsearch 组件堆内存大小 - -部署 TiUniManager 的拓扑文件支持根据真实部署中控机资源大小指定 Elasticsearch 组件的堆内存大小。通过 `elasticsearch_servers` 下的 `heap_size` 参数进行指定。例如 `16g`。 - -`heap_size` 是选填参数，不手工指定会使用默认值。默认值为 `4g`。 - -配置格式参考 [TiUniManager 拓扑配置模版 config.yaml（单机版）](#拓扑模板)。 - -## 安装 Kibana 组件（可选） - -Kibana 是一个针对 Elasticsearch 的开源分析及可视化平台，用来搜索、查看交互存储在 Elasticsearch 索引中的数据。使用 Kibana，可以通过各种图表进行高级数据分析及展示。 - -目前 TiUniManager 默认安装 Kibana，集成 Kibana 主要是做日志的展示，在控制台页面系统管理下的系统日志进行查看。 - -如果不想安装 kibana 组件，则直接在 `config.yaml` 文件中将 `kibana_servers` 组件相关的配置注释掉即可。 - -## 安全加固 - -完成 TiUniManager 安装后，建议用户通过系统防火墙为 Elasticsearch 和 Kibana 添加网络访问控制，仅允许 TiUniManager 中控机与上述组件通信，参考命令如下所示： - -```shell -# 允许来自 TiUniManager 中控机的连接 -iptables -A INPUT -p tcp -s --dport -j ACCEPT -# 拒绝其它 IP 的访问 -iptables -A INPUT -p tcp --dport -j DROP -``` diff --git a/tiunimanager/tiunimanager-login-and-initialize.md b/tiunimanager/tiunimanager-login-and-initialize.md deleted file mode 100644 index 4d0b1b16949c..000000000000 --- a/tiunimanager/tiunimanager-login-and-initialize.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: TiUniManager 登录与初始化 -summary: 了解如何登录 TiUniManager 并进行产品初始化。 ---- - -# TiUniManager 登录与初始化 - -本文档介绍如何登录 TiUniManager、进行产品初始化，以及如何退出登录。 - -## 登录 TiUniManager 控制台 - -使用 TiUniManager 进行操作前，你需要先登录 TiUniManager 控制台。 - -要登录 TiUniManager 控制台，你需要先参考 [TiUniManager 安装手册](/tiunimanager/tiunimanager-install-and-maintain.md) 开启 TiUniManager 服务。 - -> **注意：** -> -> 当前 TiUniManager 暂不支持找回密码。 - -按照以下步骤进行登录： - -1. 在浏览器中输入 TiUniManager 地址，跳转至登录页面。 -2. 在登录页面输入用户名和密码。默认用户名为 admin，密码为 admin。 -3. 点击**登录**按钮进行登录并跳转至概览页面。 - -## 退出登录 - -已登录 TiUniManager 控制台的用户可以退出登录，返回登录页面。 - -> **注意：** -> -> 退出登录后，TiUniManager 会清除缓存数据。如果再次登录同一用户，之前未保存的编辑信息会丢失。 - -操作步骤：点击用户图标，出现**退出登录**按钮，点击该按钮可退出登录并返回登录页面。 - -## 产品初始化 - -首次登录 TiUniManager 系统后，需要完成对 TiDB 所在数据中心、TiDB 产品组件、TiDB 版本信息的初始化。 - -数据中心当前默认为本地数据中心 (Local)，本地数据中心下按照区域 (Region) - 可用区(Available Zone) 2层层级来组织主机资源。 - -以下为主机资源组织结构示例： - -``` -- 本地数据中心（Local） - - 区域 Region 1 - - 可用区 Zone1_1 - - 可用区 Zone1_2 - - 区域 Region 2 - - 可用区 Zone2_1 - - 可用区 Zone2_2 -``` - -**操作步骤** - -1. 登录 TiUniManager 控制台。 -2. 进入数据中心初始化页面 - 1. 自定义填写本地数据中心的厂商名称。 - 2. 自定义填写区域 ID、区域名称。 - 3. 自定义填写可用区 ID、可用区名称。 - 4. 自定义填写 TiDB、PD、TiKV、TiFlash 实例规格。 -3. 点击**下一步**进入产品组件初始化页面。 - 5. 自定义填写组件名称。 - 6. 设置组件端口范围。 -4. 点击**下一步**进入产品版本初始化页面。选择希望安装的 TiDB 版本和架构。 -5. 点击**完成**按钮。 diff --git a/tiunimanager/tiunimanager-manage-clusters.md b/tiunimanager/tiunimanager-manage-clusters.md deleted file mode 100644 index 0a4f491ef310..000000000000 --- a/tiunimanager/tiunimanager-manage-clusters.md +++ /dev/null @@ -1,509 +0,0 @@ ---- -title: TiUniManager 集群管理 -summary: 了解如何通过 TiUniManager 对 TiDB 集群进行操作和管理。 ---- - -# TiUniManager 集群管理 - -本文档介绍如何通过 TiUniManager 对 TiDB 集群进行操作和管理。 - -## 创建集群 - -TiUniManager 部署完成后，你可以通过 TiUniManager 创建 TiDB 集群，并自定义集群配置。 - -进行操作前，确保以下条件已满足： - -* 已登录 TiUniManager 控制台 -* 已完成主机资源导入 - -创建集群的操作步骤如下： - -1. 登录控制台。 -2. 进入**集群管理** > **集群**页面。 -3. 点击**创建集群**按钮，跳转至创建实例的页面。 -4. 选择集群创建模式。 -5. 选择集群主机所在厂商、区域。 -6. 输入以下数据库基本信息： - * 数据库类型 - * CPU 体系架构 - * 数据库版本 - * 参数组 -7. 设置数据库产品各组件的以下配置： - * 所在可用区 - * 实例规格 - * 实例数量 -8. 输入集群的以下基本信息： - * 集群名称。集群名称必须是 4-64 个字符，可包含大小写字母、数字和连字符，并以字母或数字开头 - * 集群标签 - * 数据库管理员 Root 的密码。密码必须是 8-64 个字符，可包含大小写字母、数字和可见的特殊字符（包括 `!@#$%^&*()_+=）`） - * 是否独占部署 -9. 点击**提交**按钮，确认主机资源库存满足集群要求后，点击**确认创建**按钮。 - -## 删除集群 - -由于业务或其他原因，如果你不再需要某个已创建的实例，可以将某个集群删除。 - -进行操作前，确保以下条件已满足： - -* 已登录 TiUniManager 控制台。 -* 待删除的 TiDB 集群已存在。 - -> **注意：** -> -> 删除集群同时将删除集群上自动备份的数据。如果需要某个备份数据，应在删除实例之前将该备份恢复到新实例上。 - -删除集群的操作步骤如下： - -1. 登录控制台。 -2. 进入**集群管理** > **集群**页面。 -3. 选择待删除的集群，点击集群 ID 进入**集群详情**页面。 -4. 点击**删除**按钮。 -5. 选择是否在删除集群前完成一次数据备份。 -6. 选择是否保留手动备份数据。 -7. 输入 "delete" 以确认删除，点击**确认删除**按钮。 - -## 扩容集群 - -集群运行过程中，如果由于业务或其他需求，你需要为集群添加计算引擎、存储引擎或调度引擎。 - -进行操作前，确保以下条件已满足： - -* 已登录 TiUniManager 控制台。 -* 集群已创建。 - -> **注意：** -> -> * 集群配置由平台配置所限定。 -> * 推荐的 PD 实例数量为 1 个、3 个、5 个或 7 个。 -> * TiKV 实例数量不能低于 TiKV 副本数。 - -扩容的操作步骤如下： - -1. 登录控制台。 -2. 进入**集群管理** > **集群**页面。 -3. 选择待扩容的集群，点击集群 ID 进入**集群详情**页面。 -4. 点击**扩容**按钮进入扩容页面。 -5. 根据业务需要，选择要扩容引擎数量或新增不同规格的引擎数量。 -6. 点击**提交**按钮，确认资源库存满足扩容要求后，点击**确认扩容**。 - -## 缩容集群 - -在集群运行过程中，由于业务或其他需求，你需要从集群中删除多余的计算引擎、存储引擎或调度引擎。 - -进行操作前，确保以下条件已满足： - -* 已登录 TiUniManager 控制台。 -* 集群已创建。 - -> **注意：** -> -> * 集群配置由平台配置所限定。 -> * 当 TiDB、PD、TiKV 的实例数量最小为 1。当实例数等于 1 时，不能进行缩容操作。 -> * 推荐的 PD 实例数量为 1 个、3 个、5 个或 7 个。 -> * TiKV 实例数量不能小于 TiKV 副本数。对 TiKV 进行缩容时，缩容后的 TiKV 实例数量不能小于 TiKV 副本数。 - -缩容集群的操作步骤如下： - -1. 登录控制台。 -2. 进入**集群管理** > **集群**页面。 -3. 选择待删除的集群，点击集群 ID 进入**集群详情**页面。 -4. 点击待删除实例所在行的**删除**按钮。 -5. 点击**确认**按钮。 - -## 查看集群列表 - -查看实例的基本信息、运行情况，并使用集群删除按钮按需删除集群。 - -查看集群列表的操作步骤如下： - -1. 登录控制台。 -2. 进**集群管理** > **集群**页面即可查看集群列表，若暂无集群，则列表为空。 - -## 搜索集群 - -在集群列表页面，你根据以下指标搜索集群： - -* 集群运行状态（可选择） -* 集群 ID（需要输入集群 ID，暂不支持模糊搜索） -* 集群名称（需要输入集群名称，暂不支持模糊搜索） -* 标签（需要输入标签，暂不支持模糊搜索） - -搜索集群前，确保以下条件已满足： - -* 已登录平台控制台。 -* 集群已创建。 - -搜索集群的操作步骤如下： - -1. 进入**集群详情**页面。 -2. 选择搜索指标。 -3. 点击搜索按钮，确认搜索，集群详情列表展示搜索结果。 - -## 查看集群详情 - -你可通过 TiUniManager 查看集群配置、运行情况、计算、存储、调度等各引擎列表及信息详情。 - -进行操作前，确保以下条件已满足： - -* 已登录 TiUniManager 控制台。 -* 集群已创建。 - -查看集群详情的操作步骤如下： - -1. 进入**集群管理** > **集群**页面。 -2. 点击集群 ID 进入**集群详情**页面。 - -## 性能分析 - -你可通过 TiUniManager 查看集群的 SQL 语句分析、慢 SQL 查询分析、流量可视化、集群诊断。 - -进行操作前，确保以下条件已满足： - -* 已登录 TiUniManager 控制台。 -* 集群已创建。 - -性能分析的操作步骤如下： - -1. 进入**集群管理** > **集群**页面 -2. 点击集群 ID 进入**集群详情**页面，再点击**性能分析**标签页，你可看到**SQL 语句分析**、**慢查询日志**、**流量可视化**、**诊断**四个子标签页。 -3. 点击语句分析页签，进入 **SQL 语句分析**标签页。了解 [SQL 语句分析](/dashboard/dashboard-statement-details.md)详情。 -4. 点击慢查询分析页签，进入**慢查询分析**标签页。了解[慢查询分析](/analyze-slow-queries.md)详情。 -5. 点击流量可视化页签，进入**流量可视化**标签页。了解[流量可视化](/dashboard/dashboard-key-visualizer.md)详情 -6. 点击集群诊断页签，进入集群**诊断**标签页。了解[集群诊断](/dashboard/dashboard-diagnostics-access.md) 详情。 - -## 日志管理 - -在集群详情页面，你可以查看该集群各组件日志，也可以选择时间范围进行日志查询，或按照日志级别、实例 IP 地址查看日志。 - -进行操作前，确保以下条件已满足： - -* 已登录 TiUniManager 控制台。 -* 集群已创建。 - -日志管理的操作步骤如下： - -1. 进入**集群管理** > **集群**页面。 -2. 点击集群 ID 进入**集群详情**页面。 -3. 点击**日志管理**页签，进入日志管理标签页，默认以时间倒序排序展示集群日志，并可按照以下维度进行日志过滤： - * 按时间范围过滤 - * 按组件（计算、存储、调度）过滤 - * 按日志级别过滤 - * 按日志内容关键词过滤 - * 按实例 IP 地址过滤 - -## 集群监控 - -在 TiUniManager 中，你可通过集成的 Grafana 面板查看集群整体、组件、节点实例的运行情况（组件分别展示：PD、TiDB、TiKV）。 - -进行操作前，确保以下条件已满足： - -* 已登录 TiUniManager 控制台。 -* 集群已创建。 - -查看集群监控的操作步骤如下： - -1. 进入**集群管理** > **集群**页面。 -2. 点击集群 ID 进入集群详情页面，并点击**集群监控**页签。 -3. 在**集群监控**页签中，默认显示 TiDB-Summary Dashboard。 -4. 可通过选择 Dashboard 一级目录，列出所有可用 Dashboard。 - -## 告警管理 - -TiUniManager 集成了 TiDB 集群组件的报价规则，按照严重程度由高到低罗列。报警项可分为紧急级别 > 严重级别 > 警告级别三类。该分级适用于以下各组件的报警项。 - -TiDB 集群告警规则可参见在线文档：[TiDB 集群报警规则](/alert-rules.md) - -进行告警管理前，确保以下条件已满足： - -* 已登录 TiUniManager 控制台。 -* 集群已创建。 - -告警管理的操作步骤如下： - -1. 进入**集群管理** > **集群**页面。 -2. 点击集群 ID 进入集群详情页面，并点击**告警管理**页签。 - -## 参数管理 - -你可通过 TiUniManager 查看集群实例的参数信息，并修改集群的参数运行值。 - -进行操作前，确保以下条件已满足： - -* 已登录 TiUniManager 控制台 -* 集群已创建 - -参数管理的操作步骤如下： - -1. 进入**集群管理** > **集群**页面。 -2. 点击集群 ID 进入集群详情页面，并点击**参数管理**页签。 -3. 选择要修改的参数项，点击**编辑**进行修改，完成后点击**确认。** -4. 点击**保存**按钮，使参数运行值生效。 - -## 备份管理 - 数据备份 - -TiUniManager 提供自动定期备份功能。集群创建成功并开始正常运行后，你可对集群设置定期备份时间，TiUniManager 会对集群数据进行定时备份，备份的数据将保存到你所设置的存储位置中（S3 兼容存储和 NFS 共享存储）。你也可以逐条删除不需要的备份数据文件。 - -进行操作前，确保以下条件已满足： - -* 已经登录 TiUniManager 控制台。 -* 集群已创建。 - -> **注意：** -> -> * 备份保存的默认文件夹不可修改。 - -TiUniManager 默认的集群备份路径相关配置参数如下： - -| **配置描述** | **配置参数名** | **参考值** | -| ------------------------------------------------------------ | ----------------------- | ------------------------------------------------------------ | -| TiDB 集群备份的存储类型（仅支持 NFS 或 S3） | BackupStorageType | 's3' 或 'nfs' | -| TiDB 集群备份的存储路径 （S3 bucket 路径，或 NFS share 的绝对路径） | BackupStoragePath | 'bucketPath/backup' (S3 路径示例）'/mnt/nfspath' (NFS 路径示例） | -| TiDB 集群备份在 S3 共享存储时，S3 的 AccessKey | BackupS3AccessKey | '' | -| TiDB 集群备份在 S3 共享存储时，S3 的 SecretAccessKey | BackupS3SecretAccessKey | '' | -| TiDB 集群备份在 S3 共享存储时,S3 的 Endpoint（域名） | BackupS3Endpoint | '' | - -当前不支持通过 TiUniManager 界面修改备份路径。如需修改备份路径，需要通过 OpenAPI 修改配置参数，以修改配置参数 `BackupS3AccessKey` 为例： - -1. 登录 TiUniManager 获取 user token。 - - {{< copyable "shell-regular" >}} - - ```shell - 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 服务端口。 - -2. 查看配置参数值。 - - {{< copyable "shell-regular" >}} - - ```shell - curl -X GET "http://172.16.6.206:4100/api/v1/config/?configKey=BackupS3AccessKey" -H "Authorization: Bearer 6ea768e4-c0ec-4d48-b401-0f114ddc994c" - ``` - -3. 修改配置参数值。 - - {{< copyable "shell-regular" >}} - - ```shell - curl -X POST "http://172.16.6.206:4100/api/v1/config/update" -d "{ \"configKey\": \"BackupS3AccessKey\", \"configValue\": \"newValue\"}" -H "Authorization: Bearer 6ea768e4-c0ec-4d48-b401-0f114ddc994c" - ``` - -数据备份的操作步骤如下： - -1. 进入**集群管理** > **集群**页面。 -2. 点击集群 ID 进入集群详情页面，并点击**备份管理**页签。 -3. 点击**备份计划**按钮，配置自动备份策略。 -4. 点击**手动备份**按钮，立即开始手动备份。 -5. 选择备份并点击删除按钮，确认删除选择的备份。 -6. 查询某时间段的备份： - * 默认以时间倒序排序展示备份 - * 查询某时间段的备份 - -## 备份管理 - 数据恢复 - -使用 TiUniManager 的备份数据恢复功能，将一个 TiDB 集群的备份数据恢复到一个新集群。 - -进行操作前，确保以下条件已满足： - -* 已经登录控制台。 -* 集群的备份记录已存在。 - -> **注意：** -> -> 备份数据恢复到新创建的集群上，不会覆盖已创建实例。 - -数据恢复的操作步骤如下： - -1. 进入**集群管理** > **集群**页面。 -2. 点击集群 ID 进入集群详情页面，并点击**备份管理**页签。 -3. 选择要恢复的备份记录，点击**恢复**，跳转恢复集群页面。 -4. 设置新集群的名称、标签和数据库密码。 -5. 选择新集群的 Region 区域。 -6. 确认新集群的实例配置规格与数量。 -7. 点击**提交**按钮，确认创建新集群并随后开始自动恢复实例。 - -## 数据同步 - -通过 TiUniManager，你可以使用 TiDB 增量数据同步功能，从配置了 TiCDC 组件的上游 TiDB 集群，将增量数据同步到下游系统（TiDB 数据库、MySQL 数据库或 Kafka）。 - -进行操作前，确保以下条件已满足： - -* 已经登录控制台。 - -> **注意：** -> -> 数据同步功能仅支持 TiDB v5.2.2 及其以上版本。 - -数据同步的操作步骤如下： - -1. 进入**集群管理** > **集群**页面。 -2. 点击集群 ID 进入集群详情页面，并点击**数据同步**页签。 -3. 点击**创建**按钮创建数据同步任务。 -4. 填写数据同步任务基本信息： - * 任务名称 - * 同步任务开始 TSO 值（填入 “0” 则系统将从当前时刻获取起始 TSO） - * 过滤规则（参见[表库过滤语法](/table-filter.md)） -5. 填写下游信息： - * 下游类型（TiDB、MySQL、Kafka) - * 下游 URL 或 IP 地址 - * 下游数据库服务端口 - * 下游数据库用户名 - * 下游数据库密码 - * 同步任务并发数 -6. 点击**提交**按钮。 - -## 查看参数组 - -TiUniManager v1.0.0 为 TiDB v5.1.x、v5.2.x、v5.3.x、v5.4.x 提供内置的默认参数组（暂不支持 TiDB v6.0 参数组），你可查看参数组下的参数详情。 - -进行操作前，确保以下条件已满足： - -* 已经登录控制台。 - -查看参数组步骤如下： - -1. 进入**集群管理** > **参数组**页面，查看所有的参数组列表。 -2. 点击参数组名称，查看参数组中详情：参数类别、参数名称、参数列表、默认值、参数描述。 - -## 编辑、复制、应用参数组 - -TiUniManager 为 TiDB v5.1.x、v5.2.x、v5.3.x、v5.4.x 提供内置的默认参数组，你可直接应用默认参数组到集群实例，也可复制默认参数组并根据实际运行情况对参数进行调优。 - -进行操作前，确保以下条件已满足： - -* 已经登录控制台。 - -编辑、复制、应用参数组的操作步骤如下： - -1. 进入**集群管理** > **参数组**页面。 -2. 点击待修改的参数组对应的**编辑**操作，对参数组默认值进行修改。 -3. 点击待复制的参数组对应的**复制**操作，将参数组复制产生一份新的参数组。 -4. 点击参数组对应的**应用**操作，可将参数组应用到适配的集群。 - -## 接管集群 - -你可通过 TiUniManager 接管已有的 TiDB 集群。 - -进行操作前，确保以下条件已满足： - -* 已经登录控制台。 - -接管集群的操作步骤如下： - -1. 进入**集群管理 > 集群**页面。 -2. 点击**接管集群**按钮，进入接管集群页面。 -3. 输入接管集群的基本信息：集群名称、数据库用户名 root、数据库密码。 -4. 输入接管集群中控配配置信息： - * 接管集群中控机主机 IP 地址 - * 接管集群中控机 SSH 端口号 - * 接管集群中控机 SSH 用户名 - * 接管集群中控机 SSH 密码 - * 接管集群中控机 TiUP 路径（即 `.tiup` 目录所在路径，不含结尾的 `/`，例如 `/root/.tiup` ） -5. 导入接管集群的主机（导入主机流程参见[导入主机](/tiunimanager/tiunimanager-manage-host-resources.md#导入主机)）。 - -## 重启集群 - -你可在 TiUniManager 上重启指定的 TiDB 集群。 - -进行操作前，确保以下条件已满足： - -* 已经登录控制台。 - -重启集群的操作步骤如下： - -1. 进入**集群管理 > 集群**页面。 -2. 点击待重启集群的**重启**操作。 -3. 点击**确认**按钮开始重启集群。 - -## 停止集群 - -你可在 TiUniManager 上停止指定的 TiDB 集群。 - -进行操作前，确保以下条件已满足： - -* 已经登录 TiUniManager 控制台。 - -停止集群的操作步骤如下： - -1. 进入**集群管理** > **集群**页面。 -2. 选择集群，点击**停止**。 -3. 点击**确认**按钮，开始停止集群。 - -## 克隆集群 - -你可通过 TiUniManager 从一个 TiDB 集群克隆出一个新集群。新集群与源集群之间数量关系可配置为： - -* 全量：克隆集群并与源集群建立主备关系，主集群实时向备集群同步数据 -* 快照：克隆集群，但不建立主备关系 - -进行操作前，确保以下条件已满足： - -* 已经登录 TiUniManager 控制台。 -* 已有 TiDB 集群。 - -> **注意：** -> -> 克隆集群功能仅支持 TiDB v5.2.2 及其以上版本。 - -克隆集群的操作步骤如下： - -1. 进入**集群管理 > 集群**页面。 -2. 选择要产生克隆集群的源集群，进入集群详情页面。 -3. 点击**克隆集群**按钮。 -4. 选择**克隆策略。** -5. 填写新集群配置信息。 -6. 点击**提交**按钮。 - -## 切换主备集群 - -你可通过 TiUniManager 选择一个备集群，并将其切换为主集群，此时集群的原主集群将自动被切换为备集群。 - -进行操作前，确保以下条件已满足： - -* 当前 TiDB 集群为备集群。 - -> **注意：** -> -> 主备集群切换功能仅支持 TiDB v5.2.2 及其以上版本。 - -切换的操作步骤如下： - -1. 进入**集群管理** > **集群**页面。 -2. 选择备集群，进入备集群详情页面。 -3. 点击备集群后的**切换。** -4. 确认备注集群切换信息后点击**确认**按钮 - -## 原地升级集群 - -你可通过 TiUniManager 将指定的 TiDB 集群升级为更高版本的集群。 - -进行操作前，确保以下条件已满足： - -* 已经登录 TiUniManager 控制台。 - -原地升级集群的操作步骤如下： - -1. 进入**集群管理** > **集群**页面。 -2. 选择要升级的集群，进入集群详情页面。 -3. 点击**数据库版本**编号后的**升级**操作，进入集群版本升级页面。 -4. 选择目标版本、升级类型、升级方式，点击**下一步**按钮。 -5. 查看对比和合并配置参数，选择参数值为原版本值以及新版本值，点击**下一步**按钮。 -6. 确认合并后的配置参数，点击**确认**按钮。 - -## 巡检集群 - -你可通过 TiUniManager 巡检功能检查集群各个维度是否健康，包括集群资源分配是否泄露，Region 是否健康，参数配置是否正常等等。 - -进行操作前，确保以下条件已满足： - -* 已经登录 TiUniManager 控制台 - -TiUniManager 于每天 23:00 自动进行集群巡检。 - -查看巡检结果的方法：在工作流任务管理中查看任务名为 "CheckPlatform" 的任务流，点击 **checkHosts** 步骤可以查看，如下图所示： - -![集群巡检图](/media/tiunimanager/tiunimanager-checkhosts.png) diff --git a/tiunimanager/tiunimanager-manage-host-resources.md b/tiunimanager/tiunimanager-manage-host-resources.md deleted file mode 100644 index f8d80c5e16e7..000000000000 --- a/tiunimanager/tiunimanager-manage-host-resources.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: TiUniManager 主机资源管理 -summary: 如何通过 TiUniManager 管理主机资源。 ---- - -# TiUniManager 主机资源管理 - -本文档介绍如何通过 TiUniManager 管理主机资源，包括导入、查看、删除主机资源。 - -## 导入主机 - -系统初始化或者扩容机器时，系统管理员需将机器信息导入 TiUniManager 平台，TiUniManager 将导入的机器加入到集群中，由平台统一管理。 - -### 前置条件 - -将主机节点加入 TiDB 集群前，需要保证： - -- 已经登录 TiUniManager 控制台 -- 已安装主机的操作系统和所依赖的软件，并通过测试 - -> **注意：** -> -> - 你需要按照主机模板完整、正确地填写字段信息。详情参见本节中[主机模板字段说明](#主机模板字段说明)。 -> - 导入主机时，TiDB 会对主机进行检查，参见 [TiDB 环境与系统配置检查](/check-before-deployment.md)。 - -TiUniManager 中控机通过 SSH 连接主机，默认连接端口为 `22`。如果环境中 SSH 端口不为默认的 `22`，可通过 OpenAPI 修改 `config_default_ssh_port` 参数来配置主机的默认登录端口，该参数默认值为 `22`。以下示例通过 OpenAPI 修改 `config_default_ssh_port` 参数的值，从而修改主机的默认登录端口： - -1. 登录 TiUniManager 获取用户 Token。 - - {{< copyable "shell-regular" >}} - - ```shell - 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 服务端口。 - -2. 查看 `config_default_ssh_port` 的参数值。 - - {{< copyable "shell-regular" >}} - - ```shell - 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" - ``` - -3. 将 `config_default_ssh_port` 的值修改为 `newValue`。 - - {{< copyable "shell-regular" >}} - - ```shell - 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" - ``` - -### 操作步骤 - -1. 进入资源管理页面。 -2. 点击**导入主机**按钮。 -3. 点击**下载主机模板**按钮。 -4. 双击打开模板，并按照模板填入相应信息并保存。 -5. 点击**上传**按钮，选择步骤 5 中编辑的文件，并上传该文件。 -6. 点击**确认**按钮，确认导入主机信息。 - -### 主机模板字段说明 - -| 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-install-and-maintain.md#指定-tiunimanager-中控机登录-tidb-资源机的帐户和密钥)。 - -## 查看主机列表 - -查看 TiUniManager 当前管理的所有主机信息列表。 - -操作步骤如下： - -1. 登录控制台。 -2. 进入主机管理页面，在该页面即可看到主机列表。 - -## 删除主机 - -从 TiUniManager 主机资源池中删除主机。 - -操作步骤如下： - -1. 登录控制台。 -2. 进入资源管理页面。 -3. 点击主机条目的**删除**。 -4. 输入 "delete" 以确认删除操作。 -5. 点击**确认删除**按钮。 diff --git a/tiunimanager/tiunimanager-manage-system.md b/tiunimanager/tiunimanager-manage-system.md deleted file mode 100644 index eef1c91f2102..000000000000 --- a/tiunimanager/tiunimanager-manage-system.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: TiUniManager 系统管理 -summary: 了解如何通过 TiUniManager 管理系统。 ---- - -# TiUniManager 系统管理 - -本文档介绍如何通过 TiUniManager 管理系统。 - -## 查看系统监控 - -你可能需要查看 TiUniManager 系统监控，了解 TiUniManager 系统运行情况、TiUniManager 所在主机运行情况。 - -操作步骤如下： - -1. 登录 TiUniManager 控制台。 -2. 进入**系统管理** > **系统监控**页面。 -3. 选择 **EM Server**，查看 TiUniManager 系统运行情况的 Dashboard。 -4. 选择 **Node Exporter**，查看 TiUniManager 所在主机运行情况的 Dashboard。 - -## 查看系统日志 - -查看 TiUniManager 系统日志的步骤如下： - -1. 登录 TiUniManager 控制台。 -2. 进入**系统管理** > **系统日志**页面查看系统日志。 - -## TiUniManager 告警规则 - -TiUniManager 默认包含以下告警规则，以便接受相应的告警通知。 - -### work flow error alert - -* 报警规则：`sum(increase(em_work_flow_total{flow_status="Error"}[5m])) by(service, biz_type, flow_name, flow_status) > 3` -* 规则描述：错误状态工作流数量超过 3 时告警。 -* 处理方法：可能是逻辑问题。查看失败工作流，或者联系 TiUniManager 开发人员。 - -### work flow node error alert - -* 报警规则：`sum(increase(em_work_flow_node_total{flow_node_status="Error"}[5m])) by(service, biz_type, flow_name, flow_node, flow_node_status) > 3` -* 规则描述：错误状态工作流节点超过 3 时告警。 -* 处理方法：可能是逻辑问题。查看失败工作流，或者联系 TiUniManager 开发人员。 - -### cluster-server request error rate - -* 报警规则： `sum(increase(em_micro_requests_total{service="cluster-server", code!="0"}[1m]) / increase(em_micro_requests_total{service="cluster-server"}[1m])) by(service, method) > 0.05` -* 规则描述： 接口失败率超过 5% 时告警。 -* 处理方法：可以查看系统日志或系统追踪，或者联系 TiUniManager 开发人员。 - -### openapi-server request error rate - -* 报警规则： `sum(increase(em_http_requests_total{service="openapi-server", code!="200"}[1m]) / increase(em_http_requests_total{service="openapi-server"}[1m])) by(service, handler, method) > 0.05` -* 规则描述： 接口失败率超过 5% 时告警。 -* 处理方法：可以查看系统日志或系统追踪，或者联系 TiUniManager 开发人员。 - -## TiUniManager 告警设置 - -TiUniManager 告警设置支持钉钉、Email 等告警通道，具体见 [List of notifiers supported by Grafana](https://grafana.com/docs/grafana/latest/alerting/unified-alerting/contact-points/#list-of-notifiers-supported-by-grafana)。在设置 TiUniManager 告警前，确保已登录 TiUniManager 控制台。 - -以下示例基于 Grafana v7.5.15，展示如何在 Grafana 上配置钉钉的告警通道。 - -1. 打开 **Notification channels** 配置页面，点击 **New channel** 创建通道。 - - ![Notification channels - New channel](/media/tiunimanager/tiunimanager-notification-channels-new-channel.png) - -2. 配置消息接收方，示例如下： - - ![Notification channels - Edit config](/media/tiunimanager/tiunimanager-notification-channels-edit-config.png) - - 若要接入钉钉自定义机器人，参考[钉钉文档 - 自定义机器人接入](https://open.dingtalk.com/document/group/custom-robot-access)。 diff --git a/tiunimanager/tiunimanager-manage-tasks.md b/tiunimanager/tiunimanager-manage-tasks.md deleted file mode 100644 index 153f55009043..000000000000 --- a/tiunimanager/tiunimanager-manage-tasks.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: TiUniManager 工作流任务查看 -summary: ---- - -# TiUniManager 工作流任务查看 - -TiUniManager 提供工作流任务页面，你可以从该页面查看在 TiUniManager 控制台发起的用户任务进展，以及分析任务失败的原因。 - -查看工作流任务列表及详情前，确保已经登录 TiUniManager 控制台。 - -查看工作流任务列表及详情的步骤如下： - -1. 进入**工作量任务管理**页面查看任务列表，页面以时间倒序排序展示集群工作量任务。 -2. 选择要查看详情的任务，点击 **+** 图标，可进一步查看任务包含的详细步骤和执行结果。 diff --git a/tiunimanager/tiunimanager-overview.md b/tiunimanager/tiunimanager-overview.md deleted file mode 100644 index 648d0cb113b7..000000000000 --- a/tiunimanager/tiunimanager-overview.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -title: TiUniManager 概览 -summary: 了解 TiUniManager 产品定位，总体介绍。 ---- - -# TiUniManager 概览 - -TiUniManager 是为分布式数据库 TiDB 打造的管控平台软件和数据库运维管理平台，主要为 TiDB 提供数据库集群管理功能、主机管理功能和平台管理功能，涵盖了数据库运维人员 (DBA) 在 TiDB 上进行的常用运维操作，帮助 DBA 对 TiDB 进行自动化、自助化和可视化管理。 - -TiUniManager 可帮助 DBA 避免因人工操作失误导致的数据库故障，保障数据库安全、稳定、高效地运行，降低运维 TiDB 的难度，提升 DBA 工作效率。 - -自 v1.0.2 版本起，TiUniManager 正式开放源码，详见 GitHub 仓库 [tiunimanager](https://github.com/pingcap/tiunimanager)。 - -## 软件架构 - -TiUniManager 的软件架构图如下。 - -![TiUniManager 架构](/media/tiunimanager/tiunimanager-architecture.png) - -### Web UI - -TiUniManager Web UI 即用户可见的 TiUniManager 界面，展示用户输入以及服务端返回的数据。用户可与该界面进行交互，通过输入数据来获取想要看到的数据，通过界面操作完成对 TiDB 的部署运维相关工作。 - -### OpenAPI - -TiUniManager 提供数据库管理操作的 OpenAPI，帮助用户灵活完成自动化任务或第三方集成。当前 OpenAPI 为实验特性，不建议在生产环境中使用。 - -### 业务逻辑 - -TiUniManager 平台核心功能实现层，包括一键创建 TiDB 集群、删除集群、扩容集群、恢复集群、查看集群详情、集群监控报警、错误日志、慢查询日志等。实现层负责以下方面： - -- 负责后台定期备份 TiDB 数据库并保存到分布式文件系统。 -- 负责管理平台中所有主机信息的导入，主机的上线，记录主机资源使用情况。 -- 负责管理平台自身的配置信息，元信息的备份，性能监控等。 - -## 核心特性 - -本节介绍 TiUniManager 的核心特性。 - -### 易用性 - -TiUniManager 提供 Web UI 界面交互模式，UI 界面即开即用。用户根据规划添加主机形成统一的资源池，通过 TiUniManager 可一键创建指定规格的 TiDB 实例，数分钟内就可部署完成集群并对外提供服务。 - -数据库管理员 (DBA) 根据业务发展情况可随时弹性扩容 TiDB 容量及服务能力。TiUniManager 集成 DBA 常用的运维操作，所有操作都通过可视化的方式操作，极大提升 DBA 运维 TiDB 效率及易用性。 - -### 高可靠性 - -TiUniManager 支持以下特性，保障数据高可靠： - -- 支持自动备份 TiDB 数据库。用户可以设置自动备份的周期和时间。 -- 支持按备份文件进行数据恢复，且支持恢复到新的实例。为避免在恢复数据过程中影响业务，数据验证通过后 TiUniManager 将业务流量切换到新实例，完成数据回溯。 -- 支持将数据备份文件存储在分布式文件系统，通过多副本冗余和副本分布的不同策略（不同机架等）确保数据不会丢失。 -- 支持将 TiDB 部署在不同的可用区。TiDB 自身采用多副本的数据存储，TiUniManager 根据调度策略将 TiDB 的副本放在不同的可用区，实现跨机房数据可靠性功能。 - -### 高可用性 - -TiUniManager 组件均提供高可用功能，无单点故障，确保平台高可用。 - -TiDB 自身采用多副本的数据存储，TiUniManager 根据调度策略将 TiDB 的副本放在不同的可用区，并采用业界先进的 Raft 多数派选举算法确保数据 100% 强一致性和高可用。可将副本跨地域部署在不同的数据中心，主副本故障时自动切换，无需人工介入，自动保障业务的连续性，实现真正意义上的异地多活。 - -## 使用场景 - -本节介绍 TiUniManager 的使用场景。 - -### 资源管理 - -- 支持导入主机 -- 查看主机资源列表 - -### 集群管理 - -- 支持一键创建（部署） TiDB 集群，创建过程中可选择可用区、版本、规格、节点个数等 -- 支持一键接管已有 TiDB 集群 -- 支持一键删除 TiDB 集群 -- 支持一键弹性扩容 TiDB 集群，可分别扩展计算和存储能力 -- 支持一键备份与恢复集群数据 -- 支持一键查看监控报警 -- 支持一键升级集群版本 -- 支持日志管理，包括服务日志和慢查询日志等 -- 支持通过集群 ID、名称、标签等参数搜索实例 - -### 数据备份与恢复 - -- 支持设置自动备份策略 -- 支持一键手工备份 -- 支持一键删除备份记录 -- 支持从备份记录恢复至新集群 - -### 数据导入与导出 - -- 支持从 CSV 文件导入数据到 TiDB 集群 -- 支持从 SQL 文件导入数据到 TiDB 集群 -- 支持从 TiDB 集群导出数据到 CSV 文件 -- 支持从 TiDB 集群导出数据库到 SQL 文件 - -### 数据同步 - -- 支持从 TiDB 集群向下游（Kafaka、MySQL、TiDB）数据库同步数据 - -> **注意：** -> -> 数据同步功能仅支持 TiDB 5.2.2 及以上版本的集群。 - -### 克隆集群 - -- 支持克隆一个已有的 TiDB 集群，并创建一个新的 TiDB 集群 -- 支持同步克隆和快照克隆两种数据策略 - -> **注意：** -> -> 同步克隆功能仅支持 TiDB 5.2.2 及以上版本的集群。 - -### 集群参数管理 - -- 提供 TiDB 版本对应的参数组模板。关于支持的 TiDB 版本，参见 [TiUniManager 支持的 TiDB 版本](/tiunimanager/tiunimanager-release-notes.md#tiunimanager-支持的-tidb-版本)。 -- 提供统一界面查看、修改 TiDB 集群参数 - -### 工作流任务管理 - -- 支持查看从 TiUniManager 发起的所有工作流任务记录列表 -- 支持查看工作流任务详情 - -### 系统管理 - -- 支持 TiUniManager 系统监控和 TiUniManager 主机监控 -- 支持查看 TiUniManager 系统日志 -- 支持查看 TiUniManager 微服务 Trace 信息 diff --git a/tiunimanager/tiunimanager-quick-start.md b/tiunimanager/tiunimanager-quick-start.md deleted file mode 100644 index b4b697f22177..000000000000 --- a/tiunimanager/tiunimanager-quick-start.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -title: TiUniManager 快速操作指南 -summary: 了解如何快速使用 TiUniManager 进行集群操作。 ---- - -# TiUniManager 快速操作指南 - -本文档介绍 TiUniManager 的常见操作场景以及基本的集群操作，包括将主机节点加入 TiDB 集群、创建 TiDB 集群、删除集群、接管集群。 - -在阅读本文档前，你需要先阅读 [TiUniManager 安装和运维手册](/tiunimanager/tiunimanager-install-and-maintain.md)完成 TiUniManager 的安装。 - -## 将主机节点加入 TiDB 集群 - -系统初始化或者扩容机器时，系统管理员需将主机信息导入 TiUniManager 平台，TiUniManager 将导入的机器加入到集群中，由平台统一管理。 - -### 前置条件 - -将主机节点加入 TiDB 集群前，需要保证： - -- 已经登录 TiUniManager 控制台 -- 已安装主机的操作系统和所依赖的软件，并通过测试 - -> **注意：** -> -> - 你需要按照主机模板完整、正确地填写字段信息。详情参见本节中[主机模板字段说明](#主机模板字段说明)。 -> - 导入主机时，TiDB 会对主机进行检查，参见 [TiDB 环境与系统配置检查](/check-before-deployment.md)。 - -TiUniManager 中控机通过 SSH 连接主机，默认连接端口为 `22`。如果环境中 SSH 端口不为默认的 `22`，可通过 OpenAPI 修改 `config_default_ssh_port` 参数来配置主机的默认登录端口，该参数默认值为 `22`。以下示例通过 OpenAPI 修改 `config_default_ssh_port` 参数的值，从而修改主机的默认登录端口： - -1. 登录 TiUniManager 获取用户 Token。 - - {{< copyable "shell-regular" >}} - - ```shell - 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 服务端口。 - -2. 查看 `config_default_ssh_port` 的参数值。 - - {{< copyable "shell-regular" >}} - - ```shell - 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" - ``` - -3. 将 `config_default_ssh_port` 的值修改为 `newValue`。 - - {{< copyable "shell-regular" >}} - - ```shell - 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" - ``` - -### 操作步骤 - -1. 进入资源管理页面。 -2. 点击**导入主机**按钮。 -3. 点击**下载主机模板**按钮。 -4. 双击打开模板，并按照模板填入相应信息并保存。 -5. 点击**上传**按钮，选择步骤 5 中编辑的文件，并上传该文件。 -6. 点击**确认**按钮，确认导入主机信息。 - -### 主机模板字段说明 - -| 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-install-and-maintain.md#指定-tiunimanager-中控机登录-tidb-资源机的帐户和密钥)。 - -## 创建集群 - -TiUniManager 部署完成后，你可以通过 TiUniManager 创建 TiDB 集群，并自定义集群配置。 - -### 前置条件 - -- 已登录 TiUniManager 控制台 -- 已完成主机资源导入 - -### 操作步骤 - -1. 进入**集群管理** > **集群**页面。 -2. 点击创建集群按钮，跳转至创建实例的页面。 -3. 选择集群创建模式。 -4. 选择集群主机所在厂商、区域。 -5. 输入以下数据库基本信息： - - 数据库类型 - - CPU 体系架构 - - 数据库版本 - - 参数组 -6. 设置数据库产品各组件的以下配置： - - 所在可用区 - - 实例规格 - - 实例数量 -7. 输入集群的以下基本信息： - - 集群名称。集群名称必须是 4 - 64 个字符，可包含大小写字母、数字和连字符，并以字母或数字开头。 - - 集群标签 - - 数据库管理员 Root 的密码。密码必须是 8-64 个字符，可包含大小写字母、数字和可见的特殊字符（包括 `!@#$%^&*()_+=)`） - - 是否独占部署 -8. 点击**提交**按钮，确认主机资源库存满足集群要求后，点击**确认创建**按钮。 - -## 删除集群 - -由于业务或其他原因，如果你不再需要某个已创建的实例，可以将此集群删除。 - -### 前置条件 - -- 已登录 TiUniManager 控制台。 -- 待删除的 TiDB 集群已存在。 - -> **注意：** -> -> 删除集群同时将删除集群上自动备份的数据。如果需要某个备份数据，应在删除实例之前将该备份恢复到新实例上，数据恢复操作可参见[备份管理 - 数据恢复](/tiunimanager/tiunimanager-manage-clusters.md#备份管理---数据恢复)。 - -### 操作步骤 - -1. 进入**集群管理** > **集群页面**。 -2. 选择待删除的集群，点击集群 ID 进入**集群详情**页面。 -3. 点击**删除**按钮。 -4. 选择是否在删除集群前完成一次数据备份。 -5. 选择是否保留手动备份数据。 -6. 输入 "delete" 以确认删除，点击**确认删除**按钮。 - -## 接管集群 - -通过 TiUniManager 接管已经存在的 TiDB 集群，统一管理新老集群，提高集群管理效率。 - -### 前置条件 - -已经登录 TiUniManager 控制台。 - -### 操作步骤 - -1. 进入**集群管理** > **集群**页面。 -2. 点击接管集群按钮，进入**接管集群**页面。 -3. 输入接管集群的基本信息：集群名称、数据库用户名 root、数据库密码。 -4. 输入接管集群中控配配置信息： - - 接管集群中控机主机 IP 地址 - - 接管集群中控机 SSH 端口号 - - 接管集群中控机 SSH 用户名 - - 接管集群中控机 SSH 密码 - - 接管集群中控机 TiUP 路径（即 `.tiup` 目录所在路径，不含路径结尾的 `/`，例如 `/root/.tiup` 不能填写为 `/root/.tiup/`） -5. 导入接管集群的主机（导入主机流程参见[将主机节点加入 TiDB 集群](#将主机节点加入-tidb-集群)）。 \ No newline at end of file diff --git a/tiunimanager/tiunimanager-release-1.0.0.md b/tiunimanager/tiunimanager-release-1.0.0.md deleted file mode 100644 index 3717ee0dd850..000000000000 --- a/tiunimanager/tiunimanager-release-1.0.0.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: TiDB Enterprise Manager v1.0.0 Release Notes -summary: 了解 TiDB Enterprise Manager v1.0.0 版本的发版说明。 ---- - -# TiDB Enterprise Manager v1.0.0 Release Notes - -发布日期：2022 年 4 月 7 日 - -TiDB Enterprise Manager 版本：1.0.0 - -> **注意：** -> -> - TiDB Enterprise Manager v1.0.0 未开源。若要获取 v1.0.0 的安装包或相关支持，请联系 TiUniManager 团队。 -> - 自 v1.0.2 起，TiDB Enterprise Manager 正式更名为 TiUniManager。 - -TiDB Enterprise Manager 是一款以 TiDB 数据库为核心的数据库管理平台，帮助用户在本地部署环境或公有云环境中管理 TiDB 集群。 - -TiDB Enterprise Manager 不仅提供对 TiDB 集群的全生命周期的可视化管理，也同时一站式提供 TiDB 数据库参数管理、数据库版本升级、克隆集群、主备集群切换、数据导入导出、数据同步、数据备份恢复服务，能有效提高 TiDB 集群运维效率，降低企业运维成本。 - -## 用户价值 - -分布式数据库管理面临集群规模化、管理场景多元化挑战，传统的命令行管理方式面临部署成本高、技术门槛高、维护成本高等诸多挑战，TiDB Enterprise Manager 能有效解决以下场景中的分布式数据库管理难题： - -- 主机资源管理 -- 部署集群 -- 统一入口管理多套集群 -- 升级集群 -- 参数管理 -- 备份恢复 -- 数据导入导出 -- 安全与合规 -- 自动化与第三方集成 -- 管理任务历史记录可查可追溯 - -## 主要功能 - -### 集群主机资源管理 - -- 统一构建 TiDB 集群 IT 基础设施资源池，主机资源（vCPU、内存、磁盘）总量与分配用量一目了然。 -- 支持按集群类型、组件类型对主机资源分类，让最合适的主机资源匹配不同 TiDB 组件，提升主机资源利用率。 -- 支持按集群独立部署与混合部署对资源进行分类，支持在不同主机资源上灵活快速部署多套 TiDB 集群。 -- 支持主机位置信息，区域（Region) - 可用区 （Available Zone) - 机架 （Rack）三层结构清楚定义主机位置。 - -### 集群全生命周期管理 - -- 支持一站式管理多套 TiDB 集群。 - - 一个 Web 入口统一管理多套 TiDB 集群，同时查看多套集群日志、监控和告警。 - -- 支持快速灵活部署 OLTP 集群和 HTAP 集群： - - - 一页配置集群，避免直接修改拓扑和配置文件，有效降低集群配置错误 - - 一键创建集群，缩短 88% 集群创建时间 - - 规范创建流程，降低技术门槛，自动检查创建流程每一步结果，确保数据库集群健康上线，及时响应业务需求 - -- 支持扩容、缩容 TiDB 集群： - - - 支持用户根据业务需要灵活调整 TiDB 集群规模，让数据库服务能力与业务规模保持动态适配 - - 集群扩缩容过程中，确保 TiDB 组件实例数量符合最佳实践 - - 支持异步完成 TiDB 集群缩容，确保 Region 数据迁移与集群缩容有序完成 - -- 支持一键重启、停止、删除 TiDB 集群： - - - 支持一键完成 TiDB 集群日常操作 - - 删除集群前，提醒用户进行最终备份，确保数据安全 - - 优化删除集群操作的用户交互，防呆设计有效避免集群误删除 - -- 统一集成数据库监控告警和 TiDB Dashboard。 - - 统一 Web 入口实时监控多套 TiDB 数据库性能，及时发现热点和 SQL 慢查询，帮助数据库管理员跟踪数据库核心指标，提前发现数据库潜在风险。 - -- 支持统一查看 TiDB 集群日志。 - - 统一查看多套 TiDB 集群日志，支持按组件、日志级别、时间范围、日志内容、IP 地址过滤日志，帮助数据库管理员快速完成根因定位。 - -- 支持接管由 TiUP 安装的 TiDB 集群。一键接管存量 TiDB 集群，统一入口管理新老集群，提高集群管理效率。 - -### 克隆集群与一键主备切换 - -- 支持一键克隆 TiDB 集群，快速构建主备集群 - - 支持一键克隆 TiDB 集群，快速构建主备集群，自动构建数据同步任务，确保主备集群间数据保持同步，有效缩短 90% 主备集群创建时间。 - -- 支持一键切换主备集群： - - - 帮助管理员快速完成主备集群切换，自动实现数据同步任务切换，提高数据库容灾能力及业务连续性 - - 主备切换过程中确保至少有一个集群始终可读，确保数据库服务不中断 - - 主备切换过程中确保数据不丢失 - -### TiDB 集群升级 - -- 支持 TiDB 集群可视化原地升级 - - - 支持全流程可视化集群原地升级，简化数据库管理员的业务操作流程，提高集群升级成功率； - - 提供集群升级前后参数对比，允许数据库管理员核查、选择参数，避免升级前后参数变化对集群性能的影响。 - -### 参数管理 - -- 提供 TiDB 版本对应参数组模板： - - - 根据 TiDB 最佳实践经验，内置 TiDB 版本对应的参数组模板，帮助数据库管理员快速完成集群参数优化 - - 支持用户可自定义参数组，沉淀积累运营中的最佳参数组合 - - 支持用户快速应用参数组至不同集群 - -- 提供统一界面查看、修改 TiDB 集群参数： - - - 统一管理不同接口的参数（SQL、TiUP、 各组件 API），屏蔽参数管理接口细节 - - 帮助数据库管理员随时查看、调整 TiDB 集群运行参数，降低参数管理维护难度 - - 通过参数值有效校验和定期巡检，减少参数错误对集群性能带来的负面影响 - -### 数据备份与恢复 - -- 支持手动备份 TiDB 集群，帮助数据库管理员随时触发备份请求，支持查看备份进度。 -- 支持设置 TiDB 集群的自动备份策略，帮助数据库管理员设置周期性、自动化的备份策略，满足数据安全、审计的合规要求。 -- 支持从备份数据恢复创建新 TiDB 集群，备份数据与创建集群与无缝对接，快速恢复集群与数据。 -- 支持备份历史记录，方便数据库管理员查看历史备份记录，检查备份任务状态。 - -### 数据导入与导出 - -- 支持数据导入 TiDB 集群，从不同存储（S3 兼容存储、NFS 存储、本地存储）快速导入全量数据到 TiDB 集群。 - -- 支持从 TiDB 集群导出数据： - - - 从 TiDB 集群导出 SQL 或 CSV 格式的数据，可存储与 S3 兼容的存储或 NFS 存储 - - 支持按库、表过滤导出数据 - - 支持按 SQL 语句过滤导出数据 - -- 支持跨 TiDB 集群导入和导出数据。 - - 不同 TiDB 集群之间，通过 TiDB Enterprise Manager 共享存储实现跨集群的数据全量导入与导出，完成数据流动与融合，打破数据孤岛，实现数据价值挖掘。 - -- 支持导入导出历史记录，方便数据库管理员查看数据导入导出历史记录，检查任务状态。 - -### 数据同步 - -支持 TiCDC 数据同步： - -- 快速构建从 TiDB 集群到下游系统 (TiDB、MySQL、Kafka） 的数据同步任务 -- 支持数据同步任务按库、表过滤 -- 支持数据同步任务管理：创建、暂停、恢复、删除 - -### 工作流任务管理 - -- 自动记录管理员操作，历史任务事后可追查、可回溯，帮助数据库管理员查看集群历史任务记录，检查工作流执行进度与结果，快速分析操作失败原因。 -- 规范不同场景下数据库管理员操作流程。规范数据库管理员在各场景下的操作流程，避免人工操作错误与遗漏。 -- 支持异步工作流任务。管理员任务工作量支持异步，确保用户操作体验。 - -### OpenAPI（实验特性） - -提供集群全生命周期 OpenAPI： - -- 帮助管理员完成数据库管理自动化 -- 实现 TiDB 管理信息与第三方平台集成 diff --git a/tiunimanager/tiunimanager-release-1.0.1.md b/tiunimanager/tiunimanager-release-1.0.1.md deleted file mode 100644 index af4a1d36abd9..000000000000 --- a/tiunimanager/tiunimanager-release-1.0.1.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: TiDB Enterprise Manager v1.0.1 Release Notes ---- - -# TiDB Enterprise Manager v1.0.1 Release Notes - -发布日期：2022 年 5 月 30 日 - -发布版本：1.0.1 - -> **注意：** -> -> - TiDB Enterprise Manager v1.0.1 未开源。若要获取 v1.0.1 的安装包或相关支持，请联系 TiUniManager 团队。 -> - 自 v1.0.2 起，TiDB Enterprise Manager 更名为 TiUniManager。 - -该版本在 TiDB Enterprise Manager [1.0.0](/tiunimanager/tiunimanager-release-1.0.0.md) 的基础上，进行了以下更新： - -- 新增对 TiDB v6.0.0 集群的支持 -- 优化 workflow 逻辑，支持重启继续执行 -- 修复一些安全基线漏洞，提升了 TiDB Enterprise Manager 安全性 -- 替换 Elasticsearch、Filebeat、Kibana、Grafana 为 OSS 版本 - -TiDB Enterprise Manager v1.0.1 支持的 TiDB 版本如下： - -- v6.0.0 -- v5.4.0 -- v5.3.0、v5.3.1 -- v5.2.0、v5.2.1、v5.2.2、v5.2.3 -- v5.1.0、v5.1.1、v5.1.2、v5.1.3、v5.1.4 -- v5.0.0、v5.0.1、v5.0.2、v5.0.3、v5.0.4、v5.0.5、v5.0.6 diff --git a/tiunimanager/tiunimanager-release-1.0.2.md b/tiunimanager/tiunimanager-release-1.0.2.md deleted file mode 100644 index a03a126a0791..000000000000 --- a/tiunimanager/tiunimanager-release-1.0.2.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TiUniManager v1.0.2 Release Notes ---- - -# TiUniManager v1.0.2 Release Notes - -发布日期：2022 年 6 月 16 日 - -发布版本：1.0.2 - -自 v1.0.2 起，产品名由 TiDB Enterprise Manager 改为 TiUniManager，并正式开放源代码。在 [v1.0.1](/tiunimanager/tiunimanager-release-1.0.1.md) 版的基础上，v1.0.2 有如下更新： - -- 新增对 TiDB v6.1.0 集群的支持 -- 增加修改密码功能，首次安装后必须修改密码才能完成登录 - -TiUniManager v1.0.2 支持的 TiDB 版本如下： - -- v6.1.0 -- v6.0.0 -- v5.4.0 -- v5.3.0、v5.3.1 -- v5.2.0、v5.2.1、v5.2.2、v5.2.3 -- v5.1.0、v5.1.1、v5.1.2、v5.1.3、v5.1.4 -- v5.0.0、v5.0.1、v5.0.2、v5.0.3、v5.0.4、v5.0.5、v5.0.6 diff --git a/tiunimanager/tiunimanager-release-notes.md b/tiunimanager/tiunimanager-release-notes.md deleted file mode 100644 index 9c48b7a006ca..000000000000 --- a/tiunimanager/tiunimanager-release-notes.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: TiUniManager 版本发布历史 ---- - -# TiUniManager 版本发布历史 - -TiUniManager 历史版本发布声明如下： - -- [v1.0.2](/tiunimanager/tiunimanager-release-1.0.2.md) -- [v1.0.1](/tiunimanager/tiunimanager-release-1.0.1.md) -- [v1.0.0](/tiunimanager/tiunimanager-release-1.0.0.md) - -## TiUniManager 支持的 TiDB 版本 - -当前 TiUniManager 仅支持 x86_64 版本的 TiDB。 - -| TiUniManager 版本 | 支持的 TiDB 版本（仅 x86_64） | -|:----------:|:----------:| -| v1.0.2 |
  • v6.1.0
  • v6.0.0
  • v5.4.0
  • v5.3.0、v5.3.1
  • v5.2.0、v5.2.1、v5.2.2、v5.2.3
  • v5.1.0、v5.1.1、v5.1.2、v5.1.3、v5.1.4
  • v5.0.0、v5.0.1、v5.0.2、v5.0.3、v5.0.4、v5.0.5、v5.0.6
| -| v1.0.1 |
  • v6.0.0
  • v5.4.0
  • v5.3.0、v5.3.1
  • v5.2.0、v5.2.1、v5.2.2、v5.2.3
  • v5.1.0、v5.1.1、v5.1.2、v5.1.3、v5.1.4
  • v5.0.0、v5.0.1、v5.0.2、v5.0.3、v5.0.4、v5.0.5、v5.0.6
| -| v1.0.0 |
  • v5.4.0
  • v5.3.0、v5.3.1
  • v5.2.0、v5.2.1、v5.2.2、v5.2.3
  • v5.1.0、v5.1.1、v5.1.2、v5.1.3、v5.1.4
  • v5.0.0、v5.0.1、v5.0.2、v5.0.3、v5.0.4、v5.0.5、v5.0.6
|