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

reference, media: add tiflash overview doc #2155

Merged
merged 22 commits into from
Apr 7, 2020
Merged

reference, media: add tiflash overview doc #2155

merged 22 commits into from
Apr 7, 2020

Conversation

ran-huang
Copy link
Contributor

@ran-huang ran-huang commented Apr 3, 2020

What is changed, added or deleted? (Required)

  • Add English doc of tiflash-overview.md.
  • Add an image for TiFlash architecture.

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

  • master (the latest development version, including v4.0 changes for now)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)

If you select two or more versions from above, to trigger the bot to cherry-pick this PR to your desired release version branch(es), you must add corresponding labels such as needs-cherry-pick-3.1, needs-cherry-pick-3.0, and needs-cherry-pick-2.1.

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

@ran-huang ran-huang added the status/WIP This PR is still working in progress. label Apr 3, 2020
@yikeke yikeke marked this pull request as ready for review April 3, 2020 12:24
@yikeke yikeke requested review from TomShawn and yikeke April 3, 2020 12:25
@yikeke yikeke added needs-cherry-pick-3.1 translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. v4.0 This PR/issue applies to TiDB v4.0. labels Apr 3, 2020
@yikeke yikeke requested a review from ilovesoup April 3, 2020 12:29
@yikeke
Copy link
Contributor

yikeke commented Apr 3, 2020

The image was modified once in pingcap/docs-cn#2619. Please upload the latest .jpg image. @ran-huang

@ran-huang ran-huang removed the status/WIP This PR is still working in progress. label Apr 3, 2020
reference/tiflash/overview.md Outdated Show resolved Hide resolved
reference/tiflash/overview.md Outdated Show resolved Hide resolved
reference/tiflash/overview.md Outdated Show resolved Hide resolved
reference/tiflash/overview.md Outdated Show resolved Hide resolved
reference/tiflash/overview.md Outdated Show resolved Hide resolved
reference/tiflash/overview.md Outdated Show resolved Hide resolved
reference/tiflash/overview.md Outdated Show resolved Hide resolved
reference/tiflash/overview.md Outdated Show resolved Hide resolved
reference/tiflash/overview.md Outdated Show resolved Hide resolved
reference/tiflash/overview.md Outdated Show resolved Hide resolved
ilovesoup and others added 15 commits April 6, 2020 23:10
Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>
Copy link
Contributor

@ilovesoup ilovesoup left a comment

Choose a reason for hiding this comment

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

My changed made and the rest LGTM

reference/tiflash/overview.md Outdated Show resolved Hide resolved

It is recommended that you deploy TiFlash in a different node from TiKV to ensure workload isolation. It is also acceptable to deploy TiFlash and TiKV in the same node, if no business isolation is required.

Currently, data cannot be written directly into TiFlash. You need to write data in TiKV and then replicate it to TiFlash, because it connects to the TiDB cluster as a Learner role. TiFlash supports data replication in unit of table, but no data is replicated by default after deployment. To replicate data of a specified table, see [Create TiFlash replicas for tables](/reference/tiflash/use-tiflash.md#create-tiflash-replicas-for-tables).
Copy link
Contributor

Choose a reason for hiding this comment

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

Technically that is the causal relationship since learner role only accept data from other replica and cannot be operated on directly.


It is recommended that you deploy TiFlash in a different node from TiKV to ensure workload isolation. It is also acceptable to deploy TiFlash and TiKV in the same node, if no business isolation is required.

Currently, data cannot be written directly into TiFlash. You need to write data in TiKV and then replicate it to TiFlash, because it connects to the TiDB cluster as a Learner role. TiFlash supports data replication in unit of table, but no data is replicated by default after deployment. To replicate data of a specified table, see [Create TiFlash replicas for tables](/reference/tiflash/use-tiflash.md#create-tiflash-replicas-for-tables).
Copy link
Contributor

Choose a reason for hiding this comment

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

Technically that is the causal relationship since learner role only accept data from other replica and cannot be operated on directly.

reference/tiflash/overview.md Outdated Show resolved Hide resolved
reference/tiflash/overview.md Outdated Show resolved Hide resolved
reference/tiflash/overview.md Show resolved Hide resolved
yikeke and others added 2 commits April 7, 2020 09:15
Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>
Copy link
Contributor

@TomShawn TomShawn left a comment

Choose a reason for hiding this comment

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

LGTM

@TomShawn TomShawn added the status/can-merge Indicates a PR has been approved by a committer. label Apr 7, 2020
@sre-bot
Copy link
Contributor

sre-bot commented Apr 7, 2020

Your auto merge job has been accepted, waiting for 2175

@yikeke yikeke removed the status/can-merge Indicates a PR has been approved by a committer. label Apr 7, 2020
@yikeke
Copy link
Contributor

yikeke commented Apr 7, 2020

/merge

@sre-bot sre-bot added the status/can-merge Indicates a PR has been approved by a committer. label Apr 7, 2020
@sre-bot
Copy link
Contributor

sre-bot commented Apr 7, 2020

Your auto merge job has been accepted, waiting for 2175

@yikeke yikeke merged commit 548683b into pingcap:master Apr 7, 2020
sre-bot pushed a commit to sre-bot/docs that referenced this pull request Apr 7, 2020
* reference, media: add tiflash overview doc

* update pic

* update reference link

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update overview.md

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update overview.md

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update TOC.md

Co-authored-by: Soup <maxiaoyu@pingcap.com>
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
@sre-bot
Copy link
Contributor

sre-bot commented Apr 7, 2020

cherry pick to release-3.1 in PR #2177

sre-bot pushed a commit to sre-bot/docs that referenced this pull request Apr 7, 2020
Signed-off-by: sre-bot <sre-bot@pingcap.com>
@sre-bot
Copy link
Contributor

sre-bot commented Apr 7, 2020

cherry pick to release-4.0 in PR #2178

yikeke added a commit that referenced this pull request Apr 7, 2020
* reference, media: add tiflash overview doc

* update pic

* update reference link

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update overview.md

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update overview.md

* Update reference/tiflash/overview.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update TOC.md

Co-authored-by: Soup <maxiaoyu@pingcap.com>
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

Co-authored-by: Ran <huangran@pingcap.com>
Co-authored-by: Soup <maxiaoyu@pingcap.com>
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
yikeke added a commit that referenced this pull request Apr 7, 2020
* cherry pick #2155 to release-4.0

Signed-off-by: sre-bot <sre-bot@pingcap.com>

* resolve conflict

* Update TOC.md

Co-authored-by: Ran <huangran@pingcap.com>
Co-authored-by: yikeke <yikeke@pingcap.com>
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
@ran-huang ran-huang deleted the tiflash-overview branch April 7, 2020 02:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status/can-merge Indicates a PR has been approved by a committer. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. v4.0 This PR/issue applies to TiDB v4.0.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants