Skip to content

Commit

Permalink
tiunimanager: merge tiunimanager docs to master and 6.1 (pingcap#9878)
Browse files Browse the repository at this point in the history
  • Loading branch information
TomShawn authored Jun 16, 2022
1 parent d667edf commit c2a996a
Show file tree
Hide file tree
Showing 23 changed files with 2,316 additions and 7 deletions.
16 changes: 16 additions & 0 deletions TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -490,6 +490,22 @@
- [TiCDC Avro Protocol](/ticdc/ticdc-avro-protocol.md)
- [将 TiDB 集成到 Confluent Platform](/ticdc/integrate-confluent-using-ticdc.md)
- [术语表](/ticdc/ticdc-glossary.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)
- sync-diff-inspector
- [概述](/sync-diff-inspector/sync-diff-inspector-overview.md)
- [不同库名或表名的数据校验](/sync-diff-inspector/route-diff.md)
Expand Down
100 changes: 100 additions & 0 deletions config-templates/em-metadata-restore-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
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: ""

# filebeat deploy by monitored
monitored:
node_exporter_port: 4124

em_cluster_servers:
- host: 172.16.5.148
port: 4101
metrics_port: 4104
registry_client_port: 4106
registry_peer_port: 4107
# specify the recovery DB path for the central control unit
db_path: ""
deploy_dir: "/em-deploy/em-cluster-4101"
data_dir: "/em-data/em-cluster-41101"
em_api_servers:
- host: 172.16.5.148
port: 4100
metrics_port: 4103
deploy_dir: "/em-deploy/em-api-4100"
data_dir: "/em-data/em-api-4100"

em_file_servers:
- host: 172.16.5.148
port: 4102
metrics_port: 4105
deploy_dir: "/em-deploy/em-file-4102"
data_dir: "/em-data/em-file-4102"

em_web_servers:
- host: 172.16.5.148
port: 4180
deploy_dir: "/em-deploy/em-web-4180"
data_dir: "/em-data/em-web-4180"

elasticsearch_servers:
- host: 172.16.5.148
port: 4108
# Specify heap memory size, default by 4g
heap_size: "4g"
deploy_dir: "/em-deploy/elasticsearch-4108"
data_dir: "/em-data/elasticsearch-4108"

kibana_servers:
- host: 172.16.5.148
port: 4109
deploy_dir: "/em-deploy/kibana-4109"
data_dir: "/em-data/kibana-4109"
monitoring_servers:
- host: 172.16.5.148
port: 4110
deploy_dir: "/em-deploy/prometheus-4110"
data_dir: "/em-data/prometheus-4110"

grafana_servers:
- host: 172.16.5.148
port: 4111
deploy_dir: "/em-deploy/grafana-4111"
data_dir: "/em-data/grafana-4111"

alertmanager_servers:
- host: 172.16.5.148
web_port: 4112
cluster_port: 4113
deploy_dir: "/em-deploy/alertmanager-4112"
data_dir: "/em-data/alertmanager-4112"

tracer_servers:
- host: 172.16.5.148
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"

filebeat_servers:
- host: 172.16.5.148
deploy_dir: "/em-deploy/filebeat-0"
data_dir: "/em-data/filebeat-0"
98 changes: 98 additions & 0 deletions config-templates/em-topology-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
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"
25 changes: 20 additions & 5 deletions download-ecosystem-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,22 @@ aliases: ['/docs-cn/dev/download-ecosystem-tools/','/docs-cn/dev/reference/tools

# TiDB 工具下载

本文介绍如何下载 TiDB 工具包。
本文介绍如何下载 TiDB 工具包以及 [TiUniManager](/tiunimanager/tiunimanager-overview.md)

## TiDB 工具包下载

TiDB 工具包中包含了一些常用的 TiDB 工具,例如数据导出工具 Dumpling、数据导入工具 TiDB Lightning、备份恢复工具 BR。

> **建议:**
>
> 如果你的部署环境能访问互联网,无需单独下载 TiDB 工具包,可以直接通过使用 [TiUP 命令一键部署](/tiup/tiup-component-management.md)所需的 TiDB 工具。
## 环境要求
### 环境要求

- 操作系统:Linux
- 架构:amd64

## 下载步骤
### 下载步骤

1. 访问 [TiDB 社区版](https://pingcap.com/zh/product-community/)页面。
2. 找到 **TiDB-community-toolkit 软件包**,点击**立即下载**
Expand All @@ -28,7 +30,7 @@ TiDB 工具包中包含了一些常用的 TiDB 工具,例如数据导出工具
> - 点击**立即下载**后,默认下载当前 TiDB 的最新发布版本。如需下载历史版本,请在 [TiDB 社区版](https://pingcap.com/zh/product-community/)页面底部查看历史版本下载信息。
> - 如果需要在 Kubernetes 上部署运维 TiDB,无需下载 TiDB-community-toolkit 软件包,请参考[离线安装 TiDB Operator](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/deploy-tidb-operator#离线安装-tidb-operator)
## TiDB 工具包说明
### TiDB 工具包说明

在 TiDB 工具包中,你可以依据要使用的工具,选择安装对应的离线包。

Expand All @@ -44,4 +46,17 @@ TiDB 工具包中包含了一些常用的 TiDB 工具,例如数据导出工具
| [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) | `sync_diff_inspector` |
| [TiSpark](/tispark-overview.md) | `tispark-{tispark-version}-any-any.tar.gz` <br/>`spark-{spark-version}-any-any.tar.gz` |
| [PD Control](/pd-control.md) | `pd-recover-{version}-linux-amd64.tar` |
| [PD Recover](/pd-recover.md) | `etcdctl` |
| [PD Recover](/pd-recover.md) | `etcdctl` |

## 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.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`
18 changes: 16 additions & 2 deletions ecosystem-tool-user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@ TiDB 提供了丰富的工具,可以帮助你进行部署运维、数据管理

## 部署运维工具

TiDB 提供了 TiUPTiDB Operator 两种部署运维工具,满足你在不同系统环境下的部署运维需求。
TiDB 提供了 TiUPTiDB Operator 和 TiUniManager 三种部署运维工具,满足你在不同系统环境下的部署运维需求。

### 在物理机或虚拟机上部署运维 TiDB - TiUP
### 在物理机或虚拟机上部署运维 TiDB

#### TiUP

[TiUP](/tiup/tiup-overview.md) 是在物理机或虚拟机上的 TiDB 包管理器,管理着 TiDB 的众多的组件,如 TiDB、PD、TiKV 等。当你想要运行 TiDB 生态中任何组件时,只需要执行一行 TiUP 命令即可。

Expand All @@ -24,6 +26,18 @@ TiDB 提供了 TiUP 和 TiDB Operator 两种部署运维工具,满足你在不
- [TiUP 组件管理](/tiup/tiup-component-management.md)
- 适用 TiDB 版本:v4.0 及以上

#### TiUniManager

[TiUniManager](/tiunimanager/tiunimanager-overview.md) 是一款以 TiDB 数据库为核心的数据库管理平台,帮助用户在私有部署 (on-premises) 或公有云环境中管理 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 集群上。
Expand Down
Binary file added media/tiunimanager/tiunimanager-architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/tiunimanager/tiunimanager-checkhosts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit c2a996a

Please sign in to comment.