Skip to content

ticdc: update tiup deployment prompt and filter rule link (#3651) #3678

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Aug 17, 2020
Merged

ticdc: update tiup deployment prompt and filter rule link (#3651) #3678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions ticdc/manage-ticdc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ aliases: ['/docs/stable/ticdc/manage-ticdc/','/docs/v4.0/ticdc/manage-ticdc/','/

This document describes how to deploy a TiCDC cluster and how to manage the TiCDC cluster and replication tasks through the command line tool `cdc cli` and the HTTP interface.

## Deploy TiCDC
## Deploy and install TiCDC

You can deploy TiCDC using either TiUP or Binary.

Expand All @@ -21,13 +21,13 @@ In production environments, the recommendations of software and hardware for TiC
| Red Hat Enterprise Linux | 7.3 or later versions |
| CentOS | 7.3 or later versions |

| **CPU** | **Memory** | **Disk Type** | **Network** | **Instances (Minimum Requirements)** |
| **CPU** | **Memory** | **Disk type** | **Network** | **Number of TiCDC cluster instances (minimum requirements for production environment)** |
| --- | --- | --- | --- | --- |
| 16 core+ | 64 GB+ | SSD | 10 Gigabit network card (2 preferred） | 2 |

For more information, see [Software and Hardware Recommendations](/hardware-and-software-requirements.md)

### Use TiUP
### Deploy and install TiCDC using TiUP

If you use TiUP to deploy TiCDC, you can choose one of the following ways:

Expand Down Expand Up @@ -426,7 +426,7 @@ case-sensitive = true
ignore-txn-start-ts = [1, 2]

# Filter rules.
# Filter syntax: https://github.com/pingcap/tidb-tools/tree/master/pkg/table-filter#syntax.
# Filter syntax: https://docs.pingcap.com/tidb/stable/table-filter#syntax.
rules = ['*.*', '!test.*']

[mounter]
Expand All @@ -436,6 +436,7 @@ worker-num = 16
[sink]
# For the sink of MQ type, you can use dispatchers to configure the event dispatcher.
# Supports four dispatchers: default, ts, rowid, and table
# The matching syntax of matcher is the same as the filter rule syntax.
dispatchers = [
{matcher = ['test1.*', 'test2.*'], dispatcher = "ts"},
{matcher = ['test3.*', 'test4.*'], dispatcher = "rowid"},
Expand Down Expand Up @@ -482,7 +483,7 @@ To use the cyclic replication feature, you need to configure the following param

To create a cyclic replication task, take the following steps:

1. [Enable the TiCDC component](#deploy-ticdc) in TiDB cluster A, cluster B, and cluster C.
1. [Enable the TiCDC component](#deploy-and-install-ticdc) in TiDB cluster A, cluster B, and cluster C.

{{< copyable "shell-regular" >}}

Expand Down
13 changes: 11 additions & 2 deletions ticdc/ticdc-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ aliases: ['/docs/stable/ticdc/ticdc-overview/','/docs/v4.0/ticdc/ticdc-overview/

# TiCDC Overview

> **Note:**
> **Warning:**
>
> TiCDC is still an experimental feature. It is **NOT** recommended that you use it in the production environment.

Expand Down Expand Up @@ -85,9 +85,18 @@ Currently, The following scenarios are not supported:
- The [TiKV Hibernate Region](https://github.com/tikv/tikv/blob/master/docs/reference/configuration/raftstore-config.md#hibernate-region). TiCDC prevents the Region from entering the hibernated state.
- The scheduling of existing replication tables to new TiCDC nodes, after the capacity of the TiCDC cluster is scaled out.

## Install and deploy TiCDC

You can deploy TiCDC components in the process of deploying a new TiDB cluster using TiUP. You only need to [add TiCDC](/production-deployment-using-tiup.md#step-3-edit-the-initialization-configuration-file) to the configuration file when TiUP starts the TiDB cluster.

Currently, you can also add TiCDC components to an existing TiDB cluster using either TiUP or binary. For details, see [Deploy and install TiCDC](/ticdc/manage-ticdc.md#deploy-and-install-ticdc).

## Manage TiCDC Cluster and Replication Tasks

For details, see [Manage TiCDC Cluster and Replication Tasks](/ticdc/manage-ticdc.md).
Currently, you can use the `cdc cli` tool to manage the status of a TiCDC cluster and data replication tasks. For details, see:

- [Use `cdc cli` to manage cluster status and data replication task](/ticdc/manage-ticdc.md#use-cdc-cli-to-manage-cluster-status-and-data-replication-task)
- [Use HTTP interface to manage cluster status and data replication task](/ticdc/manage-ticdc.md#use-http-interface-to-manage-cluster-status-and-data-replication-task)

## Troubleshoot TiCDC

Expand Down