Skip to content

Commit

Permalink
reference: concentrate binlog documents (#1605)
Browse files Browse the repository at this point in the history
  • Loading branch information
ericsyh authored and lilin90 committed Oct 29, 2019
1 parent 4163b07 commit ba613e6
Show file tree
Hide file tree
Showing 43 changed files with 81 additions and 105 deletions.
19 changes: 9 additions & 10 deletions dev/TOC.md
Expand Up @@ -62,10 +62,6 @@
- [Overview](/dev/how-to/deploy/geographic-redundancy/overview.md)
- [Configure Location Awareness](/dev/how-to/deploy/geographic-redundancy/location-awareness.md)
- [Data Migration with Ansible](/dev/how-to/deploy/data-migration-with-ansible.md)
+ Deploy and Use TiDB Binlog
- [TiDB Binlog Cluster Deployment](/dev/how-to/deploy/tidb-binlog.md)
- [Binlog Slave Client User Guide](/dev/reference/tools/tidb-binlog/binlog-slave-client.md)
- [Reparo User Guide](/dev/reference/tools/tidb-binlog/reparo.md)
+ Configure
- [Time Zone](/dev/how-to/configure/time-zone.md)
- [Memory Control](/dev/how-to/configure/memory-control.md)
Expand All @@ -77,7 +73,6 @@
+ Monitor
- [Overview](/dev/how-to/monitor/overview.md)
- [Monitor a TiDB Cluster](/dev/how-to/monitor/monitor-a-cluster.md)
- [TiDB Binlog Monitoring](/dev/how-to/monitor/tidb-binlog.md)
+ Migrate
- [Overview](/dev/how-to/migrate/overview.md)
+ Migrate from MySQL
Expand All @@ -89,15 +84,13 @@
- [Common Ansible Operations](/dev/how-to/deploy/orchestrated/ansible-operations.md)
- [Backup and Restore](/dev/how-to/maintain/backup-and-restore.md)
- [Identify Slow Queries](/dev/how-to/maintain/identify-slow-queries.md)
- [TiDB Binlog Cluster Operations](/dev/how-to/maintain/tidb-binlog.md)
+ Scale
- [Scale using Ansible](/dev/how-to/scale/with-ansible.md)
- [Scale a TiDB Cluster](/dev/how-to/scale/horizontally.md)
+ Upgrade
- [Upgrade to TiDB 3.0](/dev/how-to/upgrade/from-previous-version.md)
- [Rolling updates with Ansible](/dev/how-to/upgrade/rolling-updates-with-ansible.md)
- [Upgrade TiDB Data Migration](/dev/reference/tools/data-migration/upgrade.md)
- [Upgrade TiDB Binlog Cluster](/dev/how-to/upgrade/tidb-binlog.md)
- Troubleshoot
- [Troubleshoot Cluster Setup](/dev/how-to/troubleshoot/cluster-setup.md)
- [Troubleshoot TiDB Data Migration](/dev/how-to/troubleshoot/data-migration.md)
Expand Down Expand Up @@ -146,8 +139,6 @@
- [Monitor](/dev/reference/tools/tidb-lightning/monitor.md)
- [Troubleshoot](/dev/how-to/troubleshoot/tidb-lightning.md)
- [FAQ](/dev/faq/tidb-lightning.md)
+ TiDB Binlog
- [FAQ](/dev/reference/tools/tidb-binlog/faq.md)
- [sync-diff-inspector](/dev/reference/tools/sync-diff-inspector/overview.md)
- [PD Control](/dev/reference/tools/pd-control.md)
- [PD Recover](/dev/reference/tools/pd-recover.md)
Expand Down Expand Up @@ -344,7 +335,15 @@
- [Tune TiKV](/dev/reference/performance/tune-tikv.md)
- [Best Practices](https://pingcap.com/blog/2017-07-24-tidbbestpractice/)
- [TiSpark](/dev/reference/tispark.md)
- [TiDB Binlog Cluster Overview](/dev/reference/tidb-binlog-overview.md)
+ TiDB Binlog
- [Overview](/dev/reference/tools/tidb-binlog/overview.md)
- [Deploy](/dev/reference/tools/tidb-binlog/deploy.md)
- [Maintain](/dev/reference/tools/tidb-binlog/maintain.md)
- [Monitor](/dev/reference/tools/tidb-binlog/monitor.md)
- [Upgrade](/dev/reference/tools/tidb-binlog/upgrade.md)
- [Reparo](/dev/reference/tools/tidb-binlog/reparo.md)
- [Binlog Slave Client](/dev/reference/tools/tidb-binlog/binlog-slave-client.md)
- [FAQ](/dev/reference/tools/tidb-binlog/faq.md)
- [Adopters](/dev/adopters.md)
+ TiDB in Kubernetes
- [About TiDB Operator](/dev/tidb-in-kubernetes/tidb-operator-overview.md)
Expand Down
2 changes: 1 addition & 1 deletion dev/how-to/deploy/orchestrated/ansible.md
Expand Up @@ -23,7 +23,7 @@ You can use the TiDB Ansible configuration file to set up the cluster topology a
- [Modify component configuration](/dev/how-to/upgrade/rolling-updates-with-ansible.md#modify-component-configuration)
- [Scale the TiDB cluster](/dev/how-to/scale/with-ansible.md)
- [Upgrade the component version](/dev/how-to/upgrade/rolling-updates-with-ansible.md#upgrade-the-component-version)
- [Enable the cluster binlog](/dev/reference/tidb-binlog-overview.md)
- [Enable the cluster binlog](/dev/reference/tools/tidb-binlog/overview.md)
- [Clean up data of the TiDB cluster](/dev/how-to/deploy/orchestrated/ansible-operations.md#clean-up-cluster-data)
- [Destroy the TiDB cluster](/dev/how-to/deploy/orchestrated/ansible-operations.md#destroy-a-cluster)

Expand Down
4 changes: 2 additions & 2 deletions dev/how-to/get-started/tidb-binlog.md
Expand Up @@ -24,7 +24,7 @@ You can use TiDB Binlog for incremental backups, to replicate data from one TiDB

TiDB Binlog is particularly useful when you migrate data from MySQL or MariaDB to TiDB, in which case you may use the TiDB DM (Data Migration) platform to get data from a MySQL/MariaDB cluster into TiDB, and then use TiDB Binlog to keep a separate, downstream MySQL/MariaDB instance/cluster in sync with your TiDB cluster. TiDB Binlog enables application traffic to TiDB to be pushed to a downstream MySQL or MariaDB instance/cluster, which reduces the risk of a migration to TiDB because you can easily revert the application to MySQL or MariaDB without downtime or data loss.

See [TiDB Binlog Cluster User Guide](/dev/reference/tidb-binlog-overview.md) for more information.
See [TiDB Binlog Cluster User Guide](/dev/reference/tools/tidb-binlog/overview.md) for more information.

## Architecture

Expand Down Expand Up @@ -328,7 +328,7 @@ You should see the same rows that you inserted into TiDB when querying the Maria

## binlogctl

Information about Pumps and Drainers that have joined the cluster is stored in PD. You can use the binlogctl tool query and manipulate information about their states. See [binlogctl guide](/dev/how-to/maintain/tidb-binlog.md#binlogctl-guide) for more information.
Information about Pumps and Drainers that have joined the cluster is stored in PD. You can use the binlogctl tool query and manipulate information about their states. See [binlogctl guide](/dev/reference/tools/tidb-binlog/maintain.md#binlogctl-guide) for more information.

Use `binlogctl` to get a view of the current status of Pumps and Drainers in the cluster:

Expand Down
2 changes: 1 addition & 1 deletion dev/how-to/upgrade/from-previous-version.md
Expand Up @@ -6,7 +6,7 @@ category: how-to

# TiDB 3.0 Upgrade Guide

This document is targeted for users who want to upgrade from TiDB 2.0 (above V2.0.1) or TiDB 2.1 RC to TiDB 3.0. TiDB 3.0 is compatible with [TiDB Binlog of Kafka Version](/dev/reference/tools/tidb-binlog/tidb-binlog-kafka.md) and [TiDB Binlog of Cluster Version](/dev/reference/tidb-binlog-overview.md).
This document is targeted for users who want to upgrade from TiDB 2.0 (above V2.0.1) or TiDB 2.1 RC to TiDB 3.0. TiDB 3.0 is compatible with [TiDB Binlog of Kafka Version](/dev/reference/tools/tidb-binlog/tidb-binlog-kafka.md) and [TiDB Binlog of Cluster Version](/dev/reference/tools/tidb-binlog/overview.md).

## Upgrade caveat

Expand Down
4 changes: 2 additions & 2 deletions dev/reference/tools/download.md
Expand Up @@ -10,7 +10,7 @@ This document collects the available downloads for most officially maintained ve

## TiDB Binlog

If you want to download the latest version of [TiDB Binlog](/dev/reference/tidb-binlog-overview.md), directly download the TiDB package, because TiDB Binlog is included in the TiDB package.
If you want to download the latest version of [TiDB Binlog](/dev/reference/tools/tidb-binlog/overview.md), directly download the TiDB package, because TiDB Binlog is included in the TiDB package.

In addition, the Kafka version of TiDB Binlog is also provided.

Expand Down Expand Up @@ -54,5 +54,5 @@ This enterprise tools package includes all the following tools:
- Syncer
- Loader
- Mydumper
- [binlogctl](/dev/reference/tidb-binlog-overview.md#binlogctl-guide)
- [binlogctl](/dev/reference/tools/tidb-binlog/overview.md#binlogctl-guide)
- [sync_diff_inspector](/dev/reference/tools/sync-diff-inspector/overview.md)
Expand Up @@ -2,6 +2,7 @@
title: TiDB Binlog Cluster Deployment
summary: Learn how to deploy TiDB Binlog cluster.
category: reference
aliases: ['/docs/dev/how-to/deploy/tidb-binlog/']
---

# TiDB Binlog Cluster Deployment
Expand Down
4 changes: 2 additions & 2 deletions dev/reference/tools/tidb-binlog/faq.md
Expand Up @@ -10,7 +10,7 @@ This document collects the frequently asked questions (FAQs) about TiDB Binlog.

## When can I pause or close a Pump or Drainer node?

Refer to [TiDB Binlog Cluster Operations](/dev/how-to/maintain/tidb-binlog.md) to learn the description of the Pump or Drainer state and how to start and exit the process.
Refer to [TiDB Binlog Cluster Operations](/dev/reference/tools/tidb-binlog/maintain.md) to learn the description of the Pump or Drainer state and how to start and exit the process.

Pause a Pump or Drainer node when you need to temporarily stop the service. For example:

Expand Down Expand Up @@ -97,7 +97,7 @@ Some stale Drainer nodes are left over from historical tasks. Their processes ha

## Can I use SQL operations such as `change pump` and `change drainer` to pause or close the Pump or Drainer service?

No. For more details on these SQL operations, refer to [Use SQL statements to manage Pump or Drainer](/dev/how-to/maintain/tidb-binlog.md#use-sql-statements-to-manage-pump-or-drainer).
No. For more details on these SQL operations, refer to [Use SQL statements to manage Pump or Drainer](/dev/reference/tools/tidb-binlog/maintain.md#use-sql-statements-to-manage-pump-or-drainer).

These SQL operations directly modifies the state information saved in PD and are functionally equivalent to the `update-pump` and `update-drainer` commands in binlogctl. To pause or close the Pump or Drainer service, use the binlogctl tool.

Expand Down
Expand Up @@ -2,6 +2,7 @@
title: TiDB Binlog Cluster Operations
summary: Learn how to operate the cluster version of TiDB Binlog.
category: reference
aliases: ['/docs/dev/how-to/maintain/tidb-binlog/']
---

# TiDB Binlog Cluster Operations
Expand Down
Expand Up @@ -2,6 +2,7 @@
title: TiDB Binlog Monitoring
summary: Learn how to monitor the cluster version of TiDB Binlog.
category: reference
aliases: ['/docs/dev/how-to/monitor/tidb-binlog/']
---

# TiDB Binlog Monitoring
Expand Down
Expand Up @@ -2,6 +2,7 @@
title: TiDB Binlog Overview
summary: Learn overview of the cluster version of TiDB Binlog.
category: reference
aliases: ['/docs/dev/reference/tidb-binlog-overview/']
---

# TiDB Binlog Cluster Overview
Expand Down Expand Up @@ -61,13 +62,3 @@ The TiDB Binlog cluster is composed of Pump and Drainer.
- If your TiDB version is 2.1.9 or later, set `db-type="file"` or `db-type="pb"`.

* If the downstream is MySQL, MariaDB, or another TiDB cluster, you can use [sync-diff-inspector](/dev/reference/tools/sync-diff-inspector/overview.md) to verify the data after data replication.

## TiDB Binlog Instructions

Once you grasp the basics from the above, you can refer to the following documents to use TiDB Binlog:

- [TiDB Binlog Tutorial](/dev/how-to/get-started/tidb-binlog.md)
- [TiDB Binlog Cluster Deployment](/dev/how-to/deploy/tidb-binlog.md)
- [TiDB Binlog Monitoring](/dev/how-to/monitor/tidb-binlog.md)
- [TiDB Binlog Cluster Operations](/dev/how-to/maintain/tidb-binlog.md)
- [Upgrade TiDB Binlog Cluster](/dev/how-to/upgrade/tidb-binlog.md)
Expand Up @@ -2,6 +2,7 @@
title: Upgrade TiDB Binlog Cluster
summary: Learn how to upgrade the cluster version of TiDB Binlog.
category: reference
aliases: ['/docs/dev/how-to/upgrade/tidb-binlog/']
---

# Upgrade TiDB Binlog Cluster
Expand All @@ -20,7 +21,7 @@ The corresponding relationship between TiDB Binlog versions and TiDB versions is

> **Note:**
>
> If importing the full data is acceptable, you can abandon the old version and deploy TiDB Binlog following [TiDB Binlog Cluster Deployment](/dev/how-to/deploy/tidb-binlog.md).
> If importing the full data is acceptable, you can abandon the old version and deploy TiDB Binlog following [TiDB Binlog Cluster Deployment](/dev/reference/tools/tidb-binlog/deploy.md).
If you want to resume replication from the original checkpoint, perform the following steps to upgrade TiDB Binlog:

Expand Down
2 changes: 1 addition & 1 deletion dev/releases/2.1ga.md
Expand Up @@ -260,7 +260,7 @@ On November 30, 2018, TiDB 2.1 GA is released. See the following updates in this

- Fast full import of large amounts of data: [TiDB Lightning](https://pingcap.com/docs/tools/lightning/overview-architecture/)

- Support new [TiDB Binlog](/dev/reference/tidb-binlog-overview.md)
- Support new [TiDB Binlog](/dev/reference/tools/tidb-binlog/overview.md)

## Upgrade caveat

Expand Down
4 changes: 2 additions & 2 deletions dev/tidb-in-kubernetes/maintain/backup-and-restore.md
Expand Up @@ -11,7 +11,7 @@ This document describes how to back up and restore the data of a TiDB cluster in
TiDB in Kubernetes supports two kinds of backup strategies:

* [Full backup](#full-backup) (scheduled or ad-hoc): use [`mydumper`](/dev/reference/tools/mydumper.md) to take a logical backup of the TiDB cluster.
* [Incremental backup](#incremental-backup): use [`TiDB Binlog`](/dev/reference/tidb-binlog-overview.md) to replicate data in the TiDB cluster to another database or take a real-time backup of the data.
* [Incremental backup](#incremental-backup): use [`TiDB Binlog`](/dev/reference/tools/tidb-binlog/overview.md) to replicate data in the TiDB cluster to another database or take a real-time backup of the data.

Currently, TiDB in Kubernetes only supports automatic [restoration](#restore) for full backup taken by `mydumper`. Restoring the incremental backup data by `TiDB Binlog` requires manual operations.

Expand Down Expand Up @@ -123,7 +123,7 @@ The `pingcap/tidb-backup` helm chart helps restore a TiDB cluster using backup d

## Incremental backup

Incremental backup uses [TiDB Binlog](/dev/reference/tidb-binlog-overview.md) to collect binlog data from TiDB and provide real-time backup and replication to downstream platforms.
Incremental backup uses [TiDB Binlog](/dev/reference/tools/tidb-binlog/overview.md) to collect binlog data from TiDB and provide real-time backup and replication to downstream platforms.

For the detailed guide of maintaining TiDB Binlog in Kubernetes, refer to [TiDB Binlog](/dev/tidb-in-kubernetes/maintain/tidb-binlog.md).

Expand Down
2 changes: 1 addition & 1 deletion dev/tidb-in-kubernetes/maintain/tidb-binlog.md
Expand Up @@ -6,7 +6,7 @@ category: how-to

# Maintain TiDB Binlog

This document describes how to maintain [TiDB Binlog](/dev/reference/tidb-binlog-overview.md) of a TiDB cluster in Kubernetes.
This document describes how to maintain [TiDB Binlog](/dev/reference/tools/tidb-binlog/overview.md) of a TiDB cluster in Kubernetes.

## Prerequisites

Expand Down
19 changes: 9 additions & 10 deletions v2.1/TOC.md
Expand Up @@ -55,10 +55,6 @@
- [Overview](/v2.1/how-to/deploy/geographic-redundancy/overview.md)
- [Configure Location Awareness](/v2.1/how-to/deploy/geographic-redundancy/location-awareness.md)
- [Data Migration with Ansible](/v2.1/how-to/deploy/data-migration-with-ansible.md)
+ Deploy and Use TiDB Binlog
- [TiDB Binlog Cluster Deployment](/v2.1/how-to/deploy/tidb-binlog.md)
- [Binlog Slave Client User Guide](/v2.1/reference/tools/tidb-binlog/binlog-slave-client.md)
- [Reparo User Guide](/v2.1/reference/tools/tidb-binlog/reparo.md)
+ Configure
- [Time Zone](/v2.1/how-to/configure/time-zone.md)
- [Memory Control](/v2.1/how-to/configure/memory-control.md)
Expand All @@ -70,7 +66,6 @@
+ Monitor
- [Overview](/v2.1/how-to/monitor/overview.md)
- [Monitor a TiDB Cluster](/v2.1/how-to/monitor/monitor-a-cluster.md)
- [TiDB Binlog Monitoring](/v2.1/how-to/monitor/tidb-binlog.md)
+ Migrate
- [Overview](/v2.1/how-to/migrate/overview.md)
+ Migrate from MySQL
Expand All @@ -82,15 +77,13 @@
- [Common Ansible Operations](/v2.1/how-to/deploy/orchestrated/ansible-operations.md)
- [Backup and Restore](/v2.1/how-to/maintain/backup-and-restore.md)
- [Identify Slow Queries](/v2.1/how-to/maintain/identify-slow-queries.md)
- [TiDB Binlog Cluster Operations](/v2.1/how-to/maintain/tidb-binlog.md)
+ Scale
- [Scale using Ansible](/v2.1/how-to/scale/with-ansible.md)
- [Scale a TiDB Cluster](/v2.1/how-to/scale/horizontally.md)
+ Upgrade
- [Upgrade to TiDB 2.1](/v2.1/how-to/upgrade/from-previous-version.md)
- [Rolling updates with Ansible](/v2.1/how-to/upgrade/rolling-updates-with-ansible.md)
- [Upgrade TiDB Data Migration](/v2.1/reference/tools/data-migration/upgrade.md)
- [Upgrade TiDB Binlog Cluster](/v2.1/how-to/upgrade/tidb-binlog.md)
- Troubleshoot
- [Troubleshoot Cluster Setup](/v2.1/how-to/troubleshoot/cluster-setup.md)
- [Troubleshoot TiDB Data Migration](/v2.1/how-to/troubleshoot/data-migration.md)
Expand Down Expand Up @@ -137,8 +130,6 @@
- [Monitor](/v2.1/reference/tools/tidb-lightning/monitor.md)
- [Troubleshoot](/v2.1/how-to/troubleshoot/tidb-lightning.md)
- [FAQ](/v2.1/faq/tidb-lightning.md)
+ TiDB Binlog
- [FAQ](/v2.1/reference/tools/tidb-binlog/faq.md)
- [sync-diff-inspector](/v2.1/reference/tools/sync-diff-inspector/overview.md)
- [PD Control](/v2.1/reference/tools/pd-control.md)
- [PD Recover](/v2.1/reference/tools/pd-recover.md)
Expand Down Expand Up @@ -319,7 +310,15 @@
- [Tune TiKV](/v2.1/reference/performance/tune-tikv.md)
- [Best Practices](https://pingcap.com/blog/2017-07-24-tidbbestpractice/)
- [TiSpark](/v2.1/reference/tispark.md)
- [TiDB Binlog Cluster Overview](/v2.1/reference/tidb-binlog-overview.md)
+ TiDB Binlog
- [Overview](/v2.1/reference/tools/tidb-binlog/overview.md)
- [Deploy](/v2.1/reference/tools/tidb-binlog/deploy.md)
- [Maintain](/v2.1/reference/tools/tidb-binlog/maintain.md)
- [Monitor](/v2.1/reference/tools/tidb-binlog/monitor.md)
- [Upgrade](/v2.1/reference/tools/tidb-binlog/upgrade.md)
- [Reparo](/v2.1/reference/tools/tidb-binlog/reparo.md)
- [Binlog Slave Client](/v2.1/reference/tools/tidb-binlog/binlog-slave-client.md)
- [FAQ](/v2.1/reference/tools/tidb-binlog/faq.md)
- [Adopters](/v2.1/adopters.md)
+ FAQs
- [TiDB FAQs](/v2.1/faq/tidb.md)
Expand Down
2 changes: 1 addition & 1 deletion v2.1/how-to/deploy/orchestrated/ansible.md
Expand Up @@ -23,7 +23,7 @@ You can use the TiDB Ansible configuration file to set up the cluster topology a
- [Modify component configuration](/v2.1/how-to/upgrade/rolling-updates-with-ansible.md#modify-component-configuration)
- [Scale the TiDB cluster](/v2.1/how-to/scale/with-ansible.md)
- [Upgrade the component version](/v2.1/how-to/upgrade/rolling-updates-with-ansible.md#upgrade-the-component-version)
- [Enable the cluster binlog](/v2.1/reference/tidb-binlog-overview.md)
- [Enable the cluster binlog](/v2.1/reference/tools/tidb-binlog/overview.md)
- [Clean up data of the TiDB cluster](/v2.1/how-to/deploy/orchestrated/ansible-operations.md#clean-up-cluster-data)
- [Destroy the TiDB cluster](/v2.1/how-to/deploy/orchestrated/ansible-operations.md#destroy-a-cluster)

Expand Down
Binary file removed v2.1/how-to/get-started/tidb-binlog-cnf.tgz
Binary file not shown.
4 changes: 2 additions & 2 deletions v2.1/how-to/get-started/tidb-binlog.md
Expand Up @@ -24,7 +24,7 @@ You can use TiDB Binlog for incremental backups, to replicate data from one TiDB

TiDB Binlog is particularly useful when you migrate data from MySQL or MariaDB to TiDB, in which case you may use the TiDB DM (Data Migration) platform to get data from a MySQL/MariaDB cluster into TiDB, and then use TiDB Binlog to keep a separate, downstream MySQL/MariaDB instance/cluster in sync with your TiDB cluster. TiDB Binlog enables application traffic to TiDB to be pushed to a downstream MySQL or MariaDB instance/cluster, which reduces the risk of a migration to TiDB because you can easily revert the application to MySQL or MariaDB without downtime or data loss.

See [TiDB Binlog Cluster User Guide](/v2.1/reference/tidb-binlog-overview.md) for more information.
See [TiDB Binlog Cluster User Guide](/v2.1/reference/tools/tidb-binlog/overview.md) for more information.

## Architecture

Expand Down Expand Up @@ -328,7 +328,7 @@ You should see the same rows that you inserted into TiDB when querying the Maria

## binlogctl

Information about Pumps and Drainers that have joined the cluster is stored in PD. You can use the binlogctl tool query and manipulate information about their states. See [binlogctl guide](/v2.1/reference/tidb-binlog-overview.md#binlogctl-guide) for more information.
Information about Pumps and Drainers that have joined the cluster is stored in PD. You can use the binlogctl tool query and manipulate information about their states. See [binlogctl guide](/v2.1/reference/tools/tidb-binlog/overview.md#binlogctl-guide) for more information.

Use `binlogctl` to get a view of the current status of Pumps and Drainers in the cluster:

Expand Down

0 comments on commit ba613e6

Please sign in to comment.