Skip to content

Commit

Permalink
op-guide, tikv: update tidb and tikv docker compose steps (#635)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
lilin90 authored Sep 29, 2018
1 parent 7dc9ee9 commit f8126e1
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
12 changes: 5 additions & 7 deletions op-guide/docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,24 +85,22 @@ To customize the cluster, you can edit the `docker-compose.yml` file directly. I

```bash
cd tidb-docker-compose
cp compose/values.yaml values.yaml
vim values.yaml
vim compose/values.yaml # custom the cluster size, docker image, port mapping and so on
```

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

[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.
[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.

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

- To build the image of a component from GitHub source code, you need to leave the `image` field empty and set `buildFrom` to `remote`.
- 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`.
- 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`.
- 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`.
- 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`.

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

```bash
helm template -f values.yaml compose > generated-docker-compose.yml
helm template compose > generated-docker-compose.yml
```

5. Create and start the cluster using the generated `docker-compose.yml` file.
Expand Down
4 changes: 2 additions & 2 deletions tikv/deploy-tikv-docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ Make sure you have installed the following items on your machine:
2. Edit the `compose/values.yaml` file to configure `networkMode` to `host` and comment the TiDB section out.

```bash
cd tidb-docker-compose/compose
networkMode: host
cd tidb-docker-compose
vim compose/values.yaml
```

3. Generate the `generated-docker-compose.yml` file.
Expand Down

0 comments on commit f8126e1

Please sign in to comment.