Skip to content

Commit 576e25b

Browse files
nrcekexium
andauthored
Add docs about TiKV cluster to gettimg-started.md (#282)
Signed-off-by: Nick Cameron <nrc@ncameron.org> Co-authored-by: Ziqian Qin <ekexium@gmail.com>
1 parent ebf7fbf commit 576e25b

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ This crate lets you connect to a TiKV cluster and use either a transactional or
1111

1212
The TiKV Rust client is an open source (Apache 2) project maintained by the TiKV Authors. We welcome contributions, see below for more info.
1313

14+
Note that the current release is not suitable for production use - APIs are not yet stable and the crate has not been thoroughly tested in real-life use.
15+
1416
## Getting started
1517

1618
The TiKV client is a Rust library (crate). To use this crate in your project, add the following dependency to your `Cargo.toml`:

getting-started.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,26 @@ async fn main() {
6262
```
6363

6464
For more examples, see the [examples](examples) directory.
65+
66+
## A TiKV cluster
67+
68+
To use the client, you'll need a TiKV instance to communicate with. In production, this should be a cluster of dedicated servers which are accessed via the network. To get started, you can run a TiKV 'cluster' on your local machine.
69+
70+
A TiKV cluster consists of TiKV nodes and PD nodes. For normal use, you need at least three of each; there is no maximum. For testing etc., you need at least one TiKV node
71+
and one PD node. For more details, see the [TiKV docs](https://tikv.org/docs/dev/concepts/architecture/).
72+
73+
The easiest way to manage a TiKV cluster (locally or on multiple machines) is to use [TiUP](https://github.com/pingcap/tiup). To install it on your computer, use
74+
75+
```
76+
curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh
77+
```
78+
79+
then, to start a local TiKV 'cluster' for testing,
80+
81+
```
82+
tiup playground nightly --kv-only
83+
```
84+
85+
For more information about TiUP, see their [docs](https://docs.pingcap.com/tidb/stable/production-deployment-using-tiup).
86+
87+
You can also build and/or run TiKV and PD instances manually. See [this blog post](https://ncameron.org/blog/building-running-and-benchmarking-tikv-and-tidb/) for details, note that you don't need the TiDB nodes.

0 commit comments

Comments
 (0)