Skip to content

Commit

Permalink
tiem: add all tiem v1.0.2 docs to master (#9304)
Browse files Browse the repository at this point in the history
* Expose dt_storage_pool_log_gc_force_hardlink_rate to users.

* Update tiflash/tiflash-configuration.md

Co-authored-by: shichun-0415 <89768198+shichun-0415@users.noreply.github.com>

* Update tiflash/tiflash-configuration.md

Co-authored-by: Grace Cai <qqzczy@126.com>

* Update tiflash/tiflash-configuration.md

* TiEM: add blank files and TOC (#9088)

* TiEM: add blank files and TOC

* fix ci

* tiem: add deploy doc and 1.0.0 release notes (#9161)

* tiem: add deploy doc and 1.0.0 release notes

* add third party library

* Update TOC.md

* Apply suggestions from code review

* tiem: add faq and quick start (#9200)

* tiem: add faq and quick start

* Update tiem/tiem-faq.md

* tiem: rename files and add a few user guides (#9215)

* tiem: rename files and add a few user guides

* fix broken links

* tiem: add tiem cluster management (#9250)

* tiem: add tiem cluster management

* Update tiem-manage-clusters.md

* Update tiem-manage-clusters.md

* Update tiem-manage-clusters.md

* Update tiem-manage-clusters.md

* Docs tiem overview (#9276)

* tiem: add tiem manage tasks, manage system, import ... (#9302)

* Docs tiem review (#9536)

* Docs tiem: add upgrade doc and release notes for 1.0.1 and 1.0.2 (#9542)

* tiem: update tiem docs for v1.0.2 open source (#9667)

* tiem: update tiem docs for v1.0.2 open source

* Update download-ecosystem-tools.md

* Update download-ecosystem-tools.md

* Update download-ecosystem-tools.md

* address comment

* Update tiem/tiem-overview.md

Co-authored-by: Lilian Lee <lilin@pingcap.com>

* delete 在线部署

Co-authored-by: Lilian Lee <lilin@pingcap.com>

* Update tiflash/tiflash-configuration.md

* Update TOC.md

* Update tiem/tiem-release-1.0.2.md

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Aolin <aolin.zhang@pingcap.com>

* Apply suggestions from code review

Co-authored-by: Aolin <aolin.zhang@pingcap.com>

Co-authored-by: jiaqizho <zhoujiaqi@pingcap.com>
Co-authored-by: jiaqizho <smalinuxer@gmail.com>
Co-authored-by: shichun-0415 <89768198+shichun-0415@users.noreply.github.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Roger Zhou <peng.zhounix@qq.com>
Co-authored-by: shenhiboy <haibo@umich.edu>
Co-authored-by: Lilian Lee <lilin@pingcap.com>
Co-authored-by: Aolin <aolin.zhang@pingcap.com>
  • Loading branch information
9 people authored Jun 6, 2022
1 parent 68abda2 commit 5d78273
Show file tree
Hide file tree
Showing 28 changed files with 2,389 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)
- TiDB Enterprise Manager
- [概述](/tiem/tiem-overview.md)
- [安装和运维](/tiem/tiem-install-and-maintain.md)
- [快速操作](/tiem/tiem-quick-start.md)
- 操作指南
- [登录与初始化](/tiem/tiem-login-and-initialize.md)
- [管理集群资源](/tiem/tiem-manage-host-resources.md)
- [管理集群](/tiem/tiem-manage-clusters.md)
- [导入与导出数据](/tiem/tiem-import-and-export-data.md)
- [管理任务](/tiem/tiem-manage-tasks.md)
- [管理系统](/tiem/tiem-manage-system.md)
- [FAQ](/tiem/tiem-faq.md)
- [发布版本历史](/tiem/tiem-release-notes.md)
- [v1.0.2](/tiem/tiem-release-1.0.2.md)
- [v1.0.1](/tiem/tiem-release-1.0.1.md)
- [v1.0.0](/tiem/tiem-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/tiem-metadata-restore-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
global:
user: "tiem"
group: "tiem"
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

tiem_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: "/tiem-deploy/tiem-cluster-4101"
data_dir: "/tiem-data/tiem-cluster-41101"
tiem_api_servers:
- host: 172.16.5.148
port: 4100
metrics_port: 4103
deploy_dir: "/tiem-deploy/tiem-api-4100"
data_dir: "/tiem-data/tiem-api-4100"

tiem_file_servers:
- host: 172.16.5.148
port: 4102
metrics_port: 4105
deploy_dir: "/tiem-deploy/tiem-file-4102"
data_dir: "/tiem-data/tiem-file-4102"

tiem_web_servers:
- host: 172.16.5.148
port: 4180
deploy_dir: "/tiem-deploy/tiem-web-4180"
data_dir: "/tiem-data/tiem-web-4180"

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

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

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

alertmanager_servers:
- host: 172.16.5.148
web_port: 4112
cluster_port: 4113
deploy_dir: "/tiem-deploy/alertmanager-4112"
data_dir: "/tiem-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: "/tiem-deploy/tracer-4114"
data_dir: "/tiem-data/tracer-4114"

filebeat_servers:
- host: 172.16.5.148
deploy_dir: "/tiem-deploy/filebeat-0"
data_dir: "/tiem-data/filebeat-0"
98 changes: 98 additions & 0 deletions config-templates/tiem-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 工具包以及 [TiDB Enterprise Manager (TiEM)](/tiem/tiem-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` |

## TiEM 下载

[TiDB Enterprise Manager (TiEM)](/tiem/tiem-overview.md) 是为 TiDB 打造的管控平台软件和数据库运维管理平台。使用下表中的链接下载 TiEM:

| 安装包 | 操作系统 | 架构 | 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}` 为 TiEM 的版本号。例如,`v1.0.2` 版本的下载链接为 `https://download.pingcap.org/tidb-toolkit-v1.0.2-linux-amd64.tar.gz`
> - TiEM 是从 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 提供了 TiUP 和 TiDB Operator 两种部署运维工具,满足你在不同系统环境下的部署运维需求。
TiDB 提供了 TiUP、TiDB Operator 和 TiDB Enterprise Manager (TiEM) 三种部署运维工具,满足你在不同系统环境下的部署运维需求。

### 在物理机或虚拟机上部署运维 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 及以上

#### TiEM

[TiDB Enterprise Manager (TiEM)](/tiem/tiem-overview.md) 是一款以 TiDB 数据库为核心的数据库管理平台,帮助用户在私有部署 (on-premises) 或公有云环境中管理 TiDB 集群。

TiEM 不仅提供对 TiDB 集群的全生命周期的可视化管理,也同时一站式提供 TiDB 数据库参数管理、数据库版本升级、克隆集群、主备集群切换、数据导入导出、数据同步、数据备份恢复服务,能有效提高 TiDB 集群运维效率,降低企业运维成本。

基本信息:

- [TiEM 使用场景](/tiem/tiem-overview.md#使用场景)
- [TiEM 安装和运维指南](/tiem/tiem-install-and-maintain.md)
- [TiEM 与 TiUP 的关系](/tiem/tiem-faq.md#tiem-与-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/tiem/tiem-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/tiem/tiem-checkhosts.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/tiem/tiem-contact-points-new-template.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/tiem/tiem-edit-messages.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/tiem/tiem-edit-policies.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/tiem/tiem-message-receiver-config.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/tiem/tiem-new-contact-point.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/tiem/tiem-notification-policies.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
62 changes: 62 additions & 0 deletions scripts/tiem-online-deploy.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
#!/bin/bash

# Prerequisite:
# 1. Install TiUP as root
# Example command:
# curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh
# 2. Prepare an EM deployment topology yaml to /opt/config.yaml
# 3. Put current script in /root/ path of EM machine and run it as root privilege, and leave the rest to the script.
# Example command:
# sh tiem_online_install.sh http://172.16.5.148:8080/tiup-repo/ /opt/config.yaml

if [ $# -ne 2 ]
then
echo "usage: $0 <online-repo-path> <em-deployment-topology-path>"
exit
fi

EM_REPO_MIRROR_PATH=$1
EM_DEPLOYMENT_TOPO=$2

echo "##### assign privileges for deployment topology file to all users started #####"
chmod 777 $EM_DEPLOYMENT_TOPO
echo "##### assign privileges for deployment topology file to all users finished #####"

echo "##### add user tidb started #####"
useradd tidb
echo "##### add user tidb finished #####"

echo "##### install TiUP to /usr/local/bin/ started #####"
install -Dm755 ~/.tiup/bin/tiup /usr/local/bin/
echo "##### install TiUP to /usr/local/bin/ finished #####"

su - tidb << EOF
echo "##### mkdir & set mirror for EM installer started #####"
mkdir -p /home/tidb/.em/bin
TIUP_HOME=/home/tidb/.em tiup mirror set $EM_REPO_MIRROR_PATH
echo "##### mkdir & set mirror for EM installer finished #####"
echo "##### mkdir & set mirror for TiDB installer started #####"
mkdir -p /home/tidb/.tiup/bin
TIUP_HOME=/home/tidb/.tiup tiup mirror set https://tiup-mirrors.pingcap.com
echo "##### mkdir & set mirror for TiDB installer finished #####"
EOF

echo "##### mkdir & set mirror for TiDB installer finished #####"


EOF

echo "##### generate identity key started, simply press enter or respond yes if needed #####"
su - tidb -c "ssh-keygen -t rsa"
su - tidb -c "cp /home/tidb/.ssh/id_rsa /home/tidb/.ssh/tiup_rsa"

echo "##### generate identity key finished #####"

echo "##### deploy EM started, you may need to provide password for central machine and respond yes if needed #####"
su - tidb -c "TIUP_HOME=/home/tidb/.em tiup em deploy em-test $VERSION $EM_DEPLOYMENT_TOPO -u root -p"
su - tidb -c "TIUP_HOME=/home/tidb/.em tiup em start em-test"
echo "##### deploy EM finished #####"
Loading

0 comments on commit 5d78273

Please sign in to comment.