Skip to content

Commit dc793a5

Browse files
authored
doc: use the tikv-slim mode in tiup >= 1.5 (#304)
Signed-off-by: ekexium <[email protected]>
1 parent c75b422 commit dc793a5

File tree

3 files changed

+10
-9
lines changed

3 files changed

+10
-9
lines changed

Makefile

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,16 @@ test: unit-test integration-test
2121
doc:
2222
cargo doc --workspace --exclude tikv-client-proto --document-private-items --no-deps
2323

24-
docker-pd:
25-
docker run -d -v $(shell pwd)/config:/config --net=host --name pd --rm pingcap/pd:latest --name "pd" --data-dir "pd" --client-urls "http://127.0.0.1:2379" --advertise-client-urls "http://127.0.0.1:2379" --config /config/pd.toml
24+
# Deprecated
25+
# docker-pd:
26+
# docker run -d -v $(shell pwd)/config:/config --net=host --name pd --rm pingcap/pd:latest --name "pd" --data-dir "pd" --client-urls "http://127.0.0.1:2379" --advertise-client-urls "http://127.0.0.1:2379" --config /config/pd.toml
2627

27-
docker-kv:
28-
docker run -d -v $(shell pwd)/config:/config --net=host --name kv --rm --ulimit nofile=90000:90000 pingcap/tikv:latest --pd-endpoints "127.0.0.1:2379" --addr "127.0.0.1:2378" --data-dir "kv" --config /config/tikv.toml
28+
# docker-kv:
29+
# docker run -d -v $(shell pwd)/config:/config --net=host --name kv --rm --ulimit nofile=90000:90000 pingcap/tikv:latest --pd-endpoints "127.0.0.1:2379" --addr "127.0.0.1:2378" --data-dir "kv" --config /config/tikv.toml
2930

30-
docker: docker-pd docker-kv
31+
# docker: docker-pd docker-kv
3132

3233
tiup:
33-
tiup playground nightly --db 0 --tiflash 0 --monitor false --kv.config $(shell pwd)/config/tikv.toml --pd.config $(shell pwd)/config/pd.toml &
34+
tiup playground nightly --mode tikv-slim --kv 3 --monitor false --kv.config $(shell pwd)/config/tikv.toml --pd.config $(shell pwd)/config/pd.toml &
3435

3536
all: check doc test

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,10 +115,10 @@ We welcome your contributions! Contributing code is great, we also appreciate fi
115115

116116
We use the standard Cargo workflows, e.g., `cargo build` to build and `cargo test` to run unit tests. You will need to use a nightly Rust toolchain to build and run tests.
117117

118-
Running integration tests or manually testing the client with a TiKV cluster is a little bit more involved. The easiest way is to use [TiUp](https://github.com/pingcap/tiup) to initialise a cluster on your local machine:
118+
Running integration tests or manually testing the client with a TiKV cluster is a little bit more involved. The easiest way is to use [TiUp](https://github.com/pingcap/tiup) (>= 1.5) to initialise a cluster on your local machine:
119119

120120
```
121-
tiup playground nightly --db 0 --tiflash 0 --monitor false
121+
tiup playground nightly --mode tikv-slim
122122
```
123123

124124
Then if you want to run integration tests:

getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh
7979
then, to start a local TiKV 'cluster' for testing,
8080

8181
```
82-
tiup playground nightly --kv-only
82+
tiup playground nightly --mode tikv-slim
8383
```
8484

8585
For more information about TiUP, see their [docs](https://docs.pingcap.com/tidb/stable/production-deployment-using-tiup).

0 commit comments

Comments
 (0)