tikv-dev-guide icon indicating copy to clipboard operation
tikv-dev-guide copied to clipboard

Published 20 hours ago • verified publisher icon tikv

Write down the first version of Understanding TiKV Overview

Open tisonkun opened this issue 4 years ago • 6 comments

https://github.com/tisonkun/tikv-dev-guide/blob/main/src/understanding-tikv/overview/intro.md

tisonkun avatar Aug 07 '21 14:08 tisonkun

@tisonkun I want to write this chapter. Please assign to me, thanks~

ystaticy avatar Apr 30 '22 04:04 ystaticy

Reference: https://docs.pingcap.com/tidb/dev/tikv-overview https://tikv.org/deep-dive/introduction/

ystaticy avatar Apr 30 '22 04:04 ystaticy

@ystaticy assigned. Go ahead!

tisonkun avatar Apr 30 '22 04:04 tisonkun

Hi, @tisonkun I found there is a TiKV intro document pr: https://github.com/tikv/tikv-dev-guide/pull/29 I want to know what is the different with TiKV Overview and TiKV Intro ?

ystaticy avatar Jul 19 '22 08:07 ystaticy

This layout is designed by @andylokandy . IIRC he states that TiKV Overview can be deeper than TiKV Intro. But if you cannot find the different, you can start with an intro about Txn KV or Raw KV. Content matters.

tisonkun avatar Jul 19 '22 08:07 tisonkun

@tisonkun

I think I can describe each logic layer of TiKV in more detail.

In order to let developers have a more systematic understanding of tikv.

I can Introduce as follows:

  1. The functions of tikv and the corresponding code logic layer; e.g. server layer,storage layer,raft layer, rocksdb layer
  2. The logic layer how to interact with other layers and how to interact with PD. e.g. PD schedule region in TiKV cluster; TiKV get TSO and GC safepoint through PD client
  3. And the inspiration source of the design or the reference paper. e.g. Transaction Design is from Percolator ,and the inspiration source of raftkv is from etcd raft.
  4. And the important functions of each module. e.g. rpc service,GC logic in TiKV server layer

What do you think of above-mentioned ?

ystaticy avatar Jul 19 '22 10:07 ystaticy