Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove all TiDB Ansible related contents from dev #5157

Merged
merged 14 commits into from
Dec 29, 2020

Conversation

TomShawn
Copy link
Contributor

@TomShawn TomShawn commented Dec 23, 2020

What is changed, added or deleted? (Required)

This PR removes all TiDB Ansible-related contents from dev.

The following types of docs are dependent on TiDB Ansible (for deployment or configuration):

  • Grafana and Prometheus (使用 TiDB Ansible 部署 TiDB 集群时,会同时部署一套 Grafana + Prometheus 的监控平台)
  • TiDB Lightning deployment (Importer-backend, TiDB-backend, Local-backend)
  • TiDB Binlog deployment and monitor
  • FAQs
  • Add aliases for deleted files (Follow up: These aliases and notes should be removed in release-5.0)

Ansible-related descriptions are removed from these docs.

Apart from these docs, Ansible-related contents cannot be directly removed from 如何对 TiDB 进行 TPC-C 测试. This doc should be rewritten. According to @shuke987's discretion, we can remove them from TOC in dev and release-5.0.

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v4.0 (TiDB 4.0 versions)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@TomShawn TomShawn added translation/doing This PR’s assignee is translating this PR. size/large Changes of a large size. status/PTAL This PR is ready for reviewing. v5.0 This PR/issue applies to TiDB v5.0 labels Dec 23, 2020
@TomShawn TomShawn self-assigned this Dec 23, 2020
@@ -6,7 +6,7 @@ aliases: ['/docs-cn/dev/best-practices/grafana-monitor-best-practices/','/docs-c

# 使用 Grafana 监控 TiDB 的最佳实践

[使用 TiDB Ansible 部署 TiDB 集群](/online-deployment-using-ansible.md)时,会同时部署一套 [Grafana + Prometheus 的监控平台](/tidb-monitoring-framework.md),用于收集和展示 TiDB 集群各个组件和机器的 metric 信息。本文主要介绍使用 TiDB 监控的最佳实践,旨在帮助 TiDB 用户高效利用丰富的 metric 信息来分析 TiDB 的集群状态或进行故障诊断。
[使用 TiUP 部署 TiDB 集群](/production-deployment-using-tiup.md)时,如果在拓扑配置中添加了 Grafana 和 Prometheus,会部署一套 [Grafana + Prometheus 的监控平台](/tidb-monitoring-framework.md),用于收集和展示 TiDB 集群各个组件和机器的 metric 信息。本文主要介绍使用 TiDB 监控的最佳实践,旨在帮助 TiDB 用户高效利用丰富的 metric 信息来分析 TiDB 的集群状态或进行故障诊断。
Copy link
Contributor Author

@TomShawn TomShawn Dec 23, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirmed with @lonng

@@ -5,7 +5,7 @@ aliases: ['/docs-cn/dev/get-started-with-tispark/','/docs-cn/dev/how-to/get-star

# TiSpark 快速上手

为了让大家快速体验 [TiSpark](/tispark-overview.md),通过 TiDB Ansible 安装的 TiDB 集群中默认已集成 Spark、TiSpark jar 包及 TiSpark sample data
为了让大家快速体验 [TiSpark](/tispark-overview.md),通过 TiUP 安装的 TiDB 集群中默认已集成 SparkTiSpark jar 包
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirmed with @marsishandsome

@@ -18,247 +18,6 @@ Pump 和 Drainer 均可部署和运行在 Intel x86-64 架构的 64 位通用硬

推荐使用 TiUP 部署 TiDB Binlog,详细部署方式参考 [TiUP 部署 TiDB Binlog](/production-deployment-using-tiup.md)。

## 使用 TiDB Ansible 部署 TiDB Binlog

### 第 1 步:下载 TiDB Ansible
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirmed with @july2993

@@ -7,22 +7,7 @@ aliases: ['/docs-cn/dev/tidb-binlog/upgrade-tidb-binlog/','/docs-cn/dev/referenc

如未特别指明,文中出现的 TiDB Binlog 均指最新的 [Cluster](/tidb-binlog/tidb-binlog-overview.md) 版本。

本文会分 TiDB Ansible 部署和手动部署两种情况介绍 TiDB Binlog 版本升级的方法,另外有一小节介绍如何从更早的不兼容版本(Kafka/Local 版本)升级到最新版本。

## TiDB Ansible 部署
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirmed with @july2993

@@ -73,69 +73,7 @@ aliases: ['/docs-cn/dev/tidb-lightning/deploy-tidb-lightning/','/docs-cn/dev/ref

## 部署 TiDB Lightning

本节介绍 TiDB Lightning 的两种部署方式:[使用 TiDB Ansible 部署](#使用-tidb-ansible-部署-tidb-lightning)和[手动部署](#手动部署-tidb-lightning)。
Copy link
Contributor Author

@TomShawn TomShawn Dec 23, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All removals of TiDB Ansible from TiDB Lightning docs are confirmed with @kennytm .

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kennytm Can we deploy TiDB Lightning using TiUP now?

@TomShawn TomShawn marked this pull request as ready for review December 23, 2020 09:06
Co-authored-by: crazycs <chen.two.cs@gmail.com>
Comment on lines 118 to 120
3)除了日志,还可以通过 `admin show slow` 命令查看,详情可参考 [`admin show slow` 命令](/identify-slow-queries.md#admin-show-slow-命令)。

2)除了日志,还可以通过 `admin show slow` 命令查看,详情可参考 [`admin show slow` 命令](/identify-slow-queries.md#admin-show-slow-命令)。
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Duplicate?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed in 9476f9f.

@ti-srebot
Copy link
Contributor

@scsldb, Thanks for your review. The bot only counts LGTMs from Reviewers and higher roles, but you're still welcome to leave your comments. See the corresponding SIG page for more information. Related SIG: docs(slack).

@ti-srebot
Copy link
Contributor

@kissmydb, @King-Dylan, PTAL.

@TomShawn TomShawn added requires-followup This PR requires a follow-up task after being merged. requires-version-specific-changes After cherry-picked, the cherry-picked PR requires further changes. labels Dec 28, 2020
tidb-lightning/tidb-lightning-backends.md Outdated Show resolved Hide resolved
tispark-overview.md Outdated Show resolved Hide resolved
@@ -73,69 +73,7 @@ aliases: ['/docs-cn/dev/tidb-lightning/deploy-tidb-lightning/','/docs-cn/dev/ref

## 部署 TiDB Lightning

本节介绍 TiDB Lightning 的两种部署方式:[使用 TiDB Ansible 部署](#使用-tidb-ansible-部署-tidb-lightning)和[手动部署](#手动部署-tidb-lightning)。
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kennytm Can we deploy TiDB Lightning using TiUP now?

@lilin90
Copy link
Member

lilin90 commented Dec 28, 2020

@TomShawn Great job! Thanks for all the notes about confirming with related engineers, which are very helpful for reviewers.

Copy link
Member

@lilin90 lilin90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ti-srebot ti-srebot removed the status/LGT1 Indicates that a PR has LGTM 1. label Dec 28, 2020
@ti-srebot ti-srebot added the status/LGT2 Indicates that a PR has LGTM 2. label Dec 28, 2020
@TomShawn TomShawn merged commit da94b8a into pingcap:master Dec 29, 2020
@TomShawn TomShawn deleted the remove-deprecated branch December 29, 2020 06:03
ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Dec 29, 2020
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot
Copy link
Contributor

cherry pick to release-5.0 in PR #5193

@TomShawn TomShawn removed the requires-followup This PR requires a follow-up task after being merged. label Dec 29, 2020
TomShawn added a commit that referenced this pull request Dec 29, 2020
* cherry pick #5157 to release-5.0

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

* vesion-specific changes

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
@TomShawn TomShawn added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR’s assignee is translating this PR. labels Dec 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
requires-version-specific-changes After cherry-picked, the cherry-picked PR requires further changes. size/large Changes of a large size. status/LGT2 Indicates that a PR has LGTM 2. status/PTAL This PR is ready for reviewing. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. v5.0 This PR/issue applies to TiDB v5.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants