Skip to content

Commit f8126e1

Browse files
authored
op-guide, tikv: update tidb and tikv docker compose steps (#635)
* op-guide: move buildFrom to buildPath for docker compose guide Via: pingcap/docs-cn#893, pingcap/tidb-docker-compose#3 * op-guide: modify yaml to yml * op-guide: address comments * op-guide: update wording to address the comment * tikv: improve code * op-guide: update `vim` in TiDB docker compose
1 parent 7dc9ee9 commit f8126e1

File tree

2 files changed

+7
-9
lines changed

2 files changed

+7
-9
lines changed

op-guide/docker-compose.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -85,24 +85,22 @@ To customize the cluster, you can edit the `docker-compose.yml` file directly. I
8585

8686
```bash
8787
cd tidb-docker-compose
88-
cp compose/values.yaml values.yaml
89-
vim values.yaml
88+
vim compose/values.yaml # custom the cluster size, docker image, port mapping and so on
9089
```
9190

9291
You can modify the configuration in `values.yaml`, such as the cluster size, TiDB image version, and so on.
9392

94-
[tidb-vision](https://github.com/pingcap/tidb-vision) is the data visualization interface of the TiDB cluster, used to visually display the PD scheduling on TiKV data. If you do not need this component, leave `tidbVision` empty.
93+
[tidb-vision](https://github.com/pingcap/tidb-vision) is the data visualization interface of the TiDB cluster, used to visually display the PD scheduling on TiKV data. If you do not need this component, comment out the `tidbVision` section.
9594

9695
For PD, TiKV, TiDB and tidb-vision, you can build Docker images from GitHub source code or local files for development and testing.
9796

98-
- To build the image of a component from GitHub source code, you need to leave the `image` field empty and set `buildFrom` to `remote`.
99-
- To build PD, TiKV or TiDB images from the locally compiled binary file, you need to leave the `image` field empty, set `buildFrom` to `local` and copy the compiled binary file to the corresponding `pd/bin/pd-server`, `tikv/bin/tikv-server`, `tidb/bin/tidb-server`.
100-
- To build the tidb-vision image from local, you need to leave the `image` field empty, set `buildFrom` to `local` and copy the tidb-vision project to `tidb-vision/tidb-vision`.
97+
- To build PD, TiKV or TiDB images from the locally compiled binary file, you need to comment out the `image` field and copy the compiled binary file to the corresponding `pd/bin/pd-server`, `tikv/bin/tikv-server`, `tidb/bin/tidb-server`.
98+
- To build the tidb-vision image from local, you need to comment out the `image` field and copy the tidb-vision project to `tidb-vision/tidb-vision`.
10199

102100
4. Generate the `docker-compose.yml` file.
103101

104102
```bash
105-
helm template -f values.yaml compose > generated-docker-compose.yml
103+
helm template compose > generated-docker-compose.yml
106104
```
107105

108106
5. Create and start the cluster using the generated `docker-compose.yml` file.

tikv/deploy-tikv-docker-compose.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ Make sure you have installed the following items on your machine:
4343
2. Edit the `compose/values.yaml` file to configure `networkMode` to `host` and comment the TiDB section out.
4444

4545
```bash
46-
cd tidb-docker-compose/compose
47-
networkMode: host
46+
cd tidb-docker-compose
47+
vim compose/values.yaml
4848
```
4949

5050
3. Generate the `generated-docker-compose.yml` file.

0 commit comments

Comments
 (0)